Interface IUserControllerApiSync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IUserControllerApiSync : IApiAccessor
Methods
View SourceGetJsonPropertyAsString(string, object, int)
Declaration
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 |
object | body | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
string | 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 |
GetJsonPropertyAsStringWithHttpInfo(string, object, int)
Declaration
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 |
object | body | |
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
ApiResponse<string> | ApiResponse 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 |
GetUserInfo(int)
Declaration
UserInfoDto GetUserInfo(int operationIndex = 0)
Parameters
Type | Name | Description |
---|---|---|
int | operationIndex | Index associated with the operation. |
Returns
Type | Description |
---|---|
UserInfoDto | UserInfoDto |
Remarks
Get account information for your user
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |
GetUserInfoWithHttpInfo(int)
Declaration
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 |
Remarks
Get account information for your user
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call |