sdk/communication/AzureCommunicationChat/Source/Generated/Options/ListChatMessagesOptions.swift

// --------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for
// license information.
//
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is
// regenerated.
// --------------------------------------------------------------------------

import AzureCore
import Foundation

// swiftlint:disable superfluous_disable_command
// swiftlint:disable identifier_name
// swiftlint:disable line_length

/// User-configurable options for the `ListChatMessages` operation.
public struct ListChatMessagesOptions: RequestOptions {
    /// 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.
    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`.
    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.
    public let clientRequestId: String?

    /// A token used to make a best-effort attempt at canceling a request.
    public let cancellationToken: CancellationToken?

    /// A dispatch queue on which to call the completion handler. Defaults to `DispatchQueue.main`.
    public var dispatchQueue: DispatchQueue?

    /// A `PipelineContext` object to associate with the request.
    public var context: PipelineContext?

    /// Initialize a `ListChatMessagesOptions` structure.
    /// - 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.
    public init(
        maxPageSize: Int32? = nil,
        startTime: Iso8601Date? = nil,
        clientRequestId: String? = nil,
        cancellationToken: CancellationToken? = nil,
        dispatchQueue: DispatchQueue? = nil,
        context: PipelineContext? = nil
    ) {
        self.maxPageSize = maxPageSize
        self.startTime = startTime
        self.clientRequestId = clientRequestId
        self.cancellationToken = cancellationToken
        self.dispatchQueue = dispatchQueue
        self.context = context
    }
}