SentSharesClient.GetAllSentShareInvitations Method

Definition

[Protocol Method] List all sent share invitations in a sent share

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Pageable<BinaryData> GetAllSentShareInvitations (string sentShareId, string filter = default, string orderby = default, Azure.RequestContext context = default);
abstract member GetAllSentShareInvitations : string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetAllSentShareInvitations : string * string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
Public Overridable Function GetAllSentShareInvitations (sentShareId As String, Optional filter As String = Nothing, Optional orderby As String = Nothing, Optional context As RequestContext = Nothing) As Pageable(Of BinaryData)

Parameters

sentShareId
String

Id of the sent share.

filter
String

Filters the results using OData syntax.

orderby
String

Sorts the results using OData syntax.

context
RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

The Pageable<T> from the service containing a list of BinaryData objects. Details of the body schema for each item in the collection are in the Remarks section below.

Exceptions

sentShareId is null.

sentShareId is an empty string, and was expected to be non-empty.

Service returned a non-success status code.

Examples

This sample shows how to call GetAllSentShareInvitations with required parameters and parse the result.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new SentSharesClient(endpoint, credential);

foreach (var item in client.GetAllSentShareInvitations("<sentShareId>"))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("invitationKind").ToString());
    Console.WriteLine(result.ToString());
}

This sample shows how to call GetAllSentShareInvitations with all parameters, and how to parse the result.

var credential = new DefaultAzureCredential();
var endpoint = new Uri("<https://my-service.azure.com>");
var client = new SentSharesClient(endpoint, credential);

foreach (var item in client.GetAllSentShareInvitations("<sentShareId>", "<filter>", "<orderby>"))
{
    JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
    Console.WriteLine(result.GetProperty("invitationKind").ToString());
    Console.WriteLine(result.GetProperty("id").ToString());
    Console.WriteLine(result.GetProperty("type").ToString());
}

Applies to