Class RecipientInvitationClient
Service client instance for RecipientInvitation.
Implements
Inherited Members
Namespace: Oci.TenantmanagercontrolplaneService
Assembly: OCI.DotNetSDK.Tenantmanagercontrolplane.dll
Syntax
public class RecipientInvitationClient : RegionalClientBase, IDisposable
Constructors
RecipientInvitationClient(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 RecipientInvitationClient(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 RecipientInvitationPaginators Paginators { get; }
Property Value
| Type | Description |
|---|---|
| RecipientInvitationPaginators |
Waiters
Declaration
public RecipientInvitationWaiters Waiters { get; }
Property Value
| Type | Description |
|---|---|
| RecipientInvitationWaiters |
Methods
AcceptRecipientInvitation(AcceptRecipientInvitationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Accepts a recipient invitation.
Declaration
public Task<AcceptRecipientInvitationResponse> AcceptRecipientInvitation(AcceptRecipientInvitationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| AcceptRecipientInvitationRequest | 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<AcceptRecipientInvitationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AcceptRecipientInvitation API.
GetRecipientInvitation(GetRecipientInvitationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the recipient invitation.
Declaration
public Task<GetRecipientInvitationResponse> GetRecipientInvitation(GetRecipientInvitationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| GetRecipientInvitationRequest | 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<GetRecipientInvitationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRecipientInvitation API.
IgnoreRecipientInvitation(IgnoreRecipientInvitationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Ignores a recipient invitation.
Declaration
public Task<IgnoreRecipientInvitationResponse> IgnoreRecipientInvitation(IgnoreRecipientInvitationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| IgnoreRecipientInvitationRequest | 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<IgnoreRecipientInvitationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use IgnoreRecipientInvitation API.
ListRecipientInvitations(ListRecipientInvitationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a (paginated) list of recipient invitations.
Declaration
public Task<ListRecipientInvitationsResponse> ListRecipientInvitations(ListRecipientInvitationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ListRecipientInvitationsRequest | 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<ListRecipientInvitationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRecipientInvitations API.
UpdateRecipientInvitation(UpdateRecipientInvitationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the recipient invitation.
Declaration
public Task<UpdateRecipientInvitationResponse> UpdateRecipientInvitation(UpdateRecipientInvitationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateRecipientInvitationRequest | 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<UpdateRecipientInvitationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateRecipientInvitation API.