Class SenderInvitationClient

Service client instance for SenderInvitation.

Inheritance

object

ClientBase

RegionalClientBase

SenderInvitationClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.TenantmanagercontrolplaneService

Assembly: OCI.DotNetSDK.Tenantmanagercontrolplane.dll

Syntax

public class SenderInvitationClient : RegionalClientBase, IDisposable

Constructors

SenderInvitationClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public SenderInvitationClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public SenderInvitationPaginators Paginators { get; }

Property Value

Type	Description
SenderInvitationPaginators

Waiters

Declaration

public SenderInvitationWaiters Waiters { get; }

Property Value

Type	Description
SenderInvitationWaiters

Methods

CancelSenderInvitation(CancelSenderInvitationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a sender invitation.

Declaration

public Task<CancelSenderInvitationResponse> CancelSenderInvitation(CancelSenderInvitationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelSenderInvitationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CancelSenderInvitationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CancelSenderInvitation API.

CreateSenderInvitation(CreateSenderInvitationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a sender invitation and asynchronously sends the invitation to the recipient.

Declaration

public Task<CreateSenderInvitationResponse> CreateSenderInvitation(CreateSenderInvitationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateSenderInvitationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateSenderInvitationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateSenderInvitation API.

GetSenderInvitation(GetSenderInvitationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about the sender invitation.

Declaration

public Task<GetSenderInvitationResponse> GetSenderInvitation(GetSenderInvitationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetSenderInvitationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetSenderInvitationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetSenderInvitation API.

ListSenderInvitations(ListSenderInvitationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return a (paginated) list of sender invitations.

Declaration

public Task<ListSenderInvitationsResponse> ListSenderInvitations(ListSenderInvitationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListSenderInvitationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListSenderInvitationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListSenderInvitations API.

UpdateSenderInvitation(UpdateSenderInvitationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the sender invitation.

Declaration

public Task<UpdateSenderInvitationResponse> UpdateSenderInvitation(UpdateSenderInvitationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateSenderInvitationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateSenderInvitationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateSenderInvitation API.

Implements

IDisposable