Interface IBuilderForOptional

Namespace

Vonage.Users.GetUsers

Assembly

Vonage.dll

Represents a builder for configuring optional parameters when retrieving users.

public interface IBuilderForOptional : IVonageRequestBuilder<GetUsersRequest>

Inherited Members

IVonageRequestBuilder<GetUsersRequest>.Create()

Methods

WithName(string)

Filters results to users matching the specified unique name.

IBuilderForOptional WithName(string value)

Parameters

value string

The exact user name to filter by.

Returns

IBuilderForOptional

The builder instance for method chaining.

Examples

.WithName("my-user")

WithOrder(FetchOrder)

Sets the sort order for the results.

IBuilderForOptional WithOrder(FetchOrder value)

Parameters

value FetchOrder

The sort order. Use Ascending for oldest first or Descending for newest first.

Returns

IBuilderForOptional

The builder instance for method chaining.

Examples

.WithOrder(FetchOrder.Descending)

WithPageSize(int)

Sets the maximum number of user records to return per page.

IBuilderForOptional WithPageSize(int value)

Parameters

value int

The page size. Defaults to 10 if not specified.

Returns

IBuilderForOptional

The builder instance for method chaining.

Examples

.WithPageSize(25)