Interface IUserControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IUserControllerApiAsync : IApiAccessor

Methods

View Source

GetJsonPropertyAsStringAsync(string, object, int, CancellationToken)

Declaration
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
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetJsonPropertyAsStringWithHttpInfoAsync(string, object, int, CancellationToken)

Declaration
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)
Remarks

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

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetUserInfoAsync(int, CancellationToken)

Declaration
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
Remarks

Get account information for your user

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetUserInfoWithHttpInfoAsync(int, CancellationToken)

Declaration
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)
Remarks

Get account information for your user

Exceptions
Type Condition
ApiException

Thrown when fails to make API call