Class UserControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

UserControllerApi

Implements

IUserControllerApi

IUserControllerApiSync

IUserControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class UserControllerApi : IUserControllerApi, IUserControllerApiSync, IUserControllerApiAsync, IApiAccessor

Constructors

View Source

UserControllerApi()

Initializes a new instance of the UserControllerApi class.

Declaration

public UserControllerApi()

View Source

UserControllerApi(Configuration)

Initializes a new instance of the UserControllerApi class using Configuration object

Declaration

public UserControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

View Source

UserControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the UserControllerApi class using a Configuration object and client instance.

Declaration

public UserControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

View Source

UserControllerApi(string)

Initializes a new instance of the UserControllerApi class.

Declaration

public UserControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

Properties

View Source

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

View Source

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

View Source

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

View Source

GetJsonPropertyAsString(string, object, int)

Utility function to extract properties from JSON objects in language where this is cumbersome.

Declaration

public string GetJsonPropertyAsString(string property, object body, int operationIndex = 0)

Parameters

Type	Name	Description
string	property	JSON property name or dot separated path selector such as `a.b.c`
object	body
int	operationIndex	Index associated with the operation.

Returns

Type	Description
string	string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetJsonPropertyAsStringAsync(string, object, int, CancellationToken)

Utility function to extract properties from JSON objects in language where this is cumbersome.

Declaration

public Task<string> GetJsonPropertyAsStringAsync(string property, object body, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	property	JSON property name or dot separated path selector such as `a.b.c`
object	body
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<string>	Task of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetJsonPropertyAsStringWithHttpInfo(string, object, int)

Utility function to extract properties from JSON objects in language where this is cumbersome.

Declaration

public ApiResponse<string> GetJsonPropertyAsStringWithHttpInfo(string property, object body, int operationIndex = 0)

Parameters

Type	Name	Description
string	property	JSON property name or dot separated path selector such as `a.b.c`
object	body
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<string>	ApiResponse of string

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetJsonPropertyAsStringWithHttpInfoAsync(string, object, int, CancellationToken)

Utility function to extract properties from JSON objects in language where this is cumbersome.

Declaration

public Task<ApiResponse<string>> GetJsonPropertyAsStringWithHttpInfoAsync(string property, object body, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	property	JSON property name or dot separated path selector such as `a.b.c`
object	body
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<string>>	Task of ApiResponse (string)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetUserInfo(int)

Get account information for your user

Declaration

public UserInfoDto GetUserInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
UserInfoDto	UserInfoDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetUserInfoAsync(int, CancellationToken)

Get account information for your user

Declaration

public Task<UserInfoDto> GetUserInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<UserInfoDto>	Task of UserInfoDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetUserInfoWithHttpInfo(int)

Get account information for your user

Declaration

public ApiResponse<UserInfoDto> GetUserInfoWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<UserInfoDto>	ApiResponse of UserInfoDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetUserInfoWithHttpInfoAsync(int, CancellationToken)

Get account information for your user

Declaration

public Task<ApiResponse<UserInfoDto>> GetUserInfoWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<UserInfoDto>>	Task of ApiResponse (UserInfoDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IUserControllerApi

IUserControllerApiSync

IUserControllerApiAsync

IApiAccessor