ListChatMessagesOptions

public struct ListChatMessagesOptions : RequestOptions

User-configurable options for the ListChatMessages operation.

  • The maximum number of messages to be returned per page. The limit can be found from https://docs.microsoft.com/azure/communication-services/concepts/service-limits.

    Declaration

    Swift

    public let maxPageSize: Int32?

  • The earliest point in time to get messages up to. The timestamp should be in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.

    Declaration

    Swift

    public let startTime: Iso8601Date?

  • 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 ListChatMessagesOptions structure.

    Declaration

    Swift

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

    Parameters

    maxPageSize

    The maximum number of messages to be returned per page. The limit can be found from https://docs.microsoft.com/azure/communication-services/concepts/service-limits.
    startTime

    The earliest point in time to get messages up to. The timestamp should be in RFC3339 format: yyyy-MM-ddTHH:mm:ssZ.
    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.