ListChatParticipantsOptions

public struct ListChatParticipantsOptions : RequestOptions

User-configurable options for the ListChatParticipants operation.

  • The maximum number of participants to be returned per page.

    Declaration

    Swift

    public let maxPageSize: Int32?
  • Skips participants up to a specified position in response.

    Declaration

    Swift

    public let skip: Int32?
  • A client-generated, opaque value with 1KB character limit that is recorded in analytics logs. Highly recommended for correlating client-side activites with requests received by the server.

    Declaration

    Swift

    public let clientRequestId: String?
  • A token used to make a best-effort attempt at canceling a request.

    Declaration

    Swift

    public let cancellationToken: CancellationToken?
  • A dispatch queue on which to call the completion handler. Defaults to DispatchQueue.main.

    Declaration

    Swift

    public var dispatchQueue: DispatchQueue?
  • A PipelineContext object to associate with the request.

    Declaration

    Swift

    public var context: PipelineContext?
  • Initialize a ListChatParticipantsOptions structure.

    Declaration

    Swift

    public init(
        maxPageSize: Int32? = nil,
        skip: Int32? = nil,
        clientRequestId: String? = nil,
        cancellationToken: CancellationToken? = nil,
        dispatchQueue: DispatchQueue? = nil,
        context: PipelineContext? = nil
    )

    Parameters

    maxPageSize

    The maximum number of participants to be returned per page.

    skip

    Skips participants up to a specified position in response.

    clientRequestId

    A client-generated, opaque value with 1KB character limit that is recorded in analytics logs.

    cancellationToken

    A token used to make a best-effort attempt at canceling a request.

    dispatchQueue

    A dispatch queue on which to call the completion handler. Defaults to DispatchQueue.main.

    context

    A PipelineContext object to associate with the request.