Struct GetUserRequest

Namespace

Vonage.Users.GetUser

Assembly

Vonage.dll

Represents a request to retrieve a specific user by their unique identifier.

public readonly struct GetUserRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

UserId

The unique identifier of the user to retrieve (e.g., "USR-12345678-1234-1234-1234-123456789012").

public string UserId { get; }

Property Value

string

Methods

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.

Parse(string)

Creates a GetUserRequest from the specified user ID.

public static Result<GetUserRequest> Parse(string userId)

Parameters

userId string

The unique identifier of the user to retrieve. Must not be empty.

Returns

Result<GetUserRequest>

A result containing the GetUserRequest on success, or validation error details if the user ID is empty.