ListChatThreadsOptions

public struct ListChatThreadsOptions : RequestOptions

User-configurable options for the ListChatThreads operation.

  • The maximum number of chat threads returned per page.

    Declaration

    Swift

    public let maxPageSize: Int32?
  • The earliest point in time to get chat threads 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 ListChatThreadsOptions 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 chat threads returned per page.

    startTime

    The earliest point in time to get chat threads 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.