CreateChatThreadOptions Structure Reference


                    
                    
                    repeatabilityRequestId

If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.

Declaration

Swift

public let repeatabilityRequestId: String?


                    
                    
                    clientRequestId

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?


                    
                    
                    cancellationToken

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

Declaration

Swift

public let cancellationToken: CancellationToken?


                    
                    
                    dispatchQueue

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

Declaration

Swift

public var dispatchQueue: DispatchQueue?


                    
                    
                    context

A PipelineContext object to associate with the request.

Declaration

Swift

public var context: PipelineContext?


                    
                    
                    init(repeatabilityRequestId:clientRequestId:cancellationToken:dispatchQueue:context:)

Initialize a CreateChatThreadOptions structure.

Declaration

Swift

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

Parameters

`repeatabilityRequestId`	If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs.
`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.