Class User

Namespace

Vonage.Users

Assembly

Vonage.dll

Represents a user in the Vonage platform with their profile and communication channels.

public record User : IEquatable<User>

Inheritance

object

User

Implements

IEquatable<User>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

User(string, string, string, Uri, Dictionary<string, object>, UserChannels, HalLinks)

Represents a user in the Vonage platform with their profile and communication channels.

public User(string Id, string Name, string DisplayName, Uri ImageUrl, Dictionary<string, object> Properties, UserChannels Channels, HalLinks Links)

Parameters

Id string

The unique identifier for the user.

Name string

The unique name for the user.

DisplayName string

A display name for the user. Does not need to be unique.

ImageUrl Uri

An image URL associated with the user's profile.

Properties Dictionary<string, object>

Custom properties associated with the user.

Channels UserChannels

The communication channels configured for the user.

Links HalLinks

HAL links for related resources.

Properties

Channels

The communication channels configured for the user.

[JsonPropertyName("channels")]
[JsonPropertyOrder(5)]
public UserChannels Channels { get; init; }

Property Value

UserChannels

DisplayName

A display name for the user. Does not need to be unique.

[JsonPropertyName("display_name")]
[JsonPropertyOrder(2)]
public string DisplayName { get; init; }

Property Value

string

Id

The unique identifier for the user.

[JsonPropertyName("id")]
[JsonPropertyOrder(0)]
public string Id { get; init; }

Property Value

string

ImageUrl

An image URL associated with the user's profile.

[JsonPropertyName("image_url")]
[JsonPropertyOrder(3)]
public Uri ImageUrl { get; init; }

Property Value

Uri

Links

HAL links for related resources.

[JsonPropertyName("_links")]
[JsonPropertyOrder(6)]
public HalLinks Links { get; init; }

Property Value

HalLinks

Name

The unique name for the user.

[JsonPropertyName("name")]
[JsonPropertyOrder(1)]
public string Name { get; init; }

Property Value

string

Properties

Custom properties associated with the user.

[JsonPropertyName("properties")]
[JsonPropertyOrder(4)]
public Dictionary<string, object> Properties { get; init; }

Property Value

Dictionary<string, object>