ListMessagesOptions interface

Os detalhes utilizados para listar mensagens.

Extends

Propriedades

after

Um cursor para utilização na paginação. depois é um ID de objeto que define o seu lugar na lista. Por exemplo, se fizer um pedido de lista e receber 100 objetos, terminando com obj_foo, a chamada subsequente pode incluir after=obj_foo para obter a página seguinte da lista.

before

Um cursor para utilização na paginação. antes é um ID de objeto que define o seu lugar na lista. Por exemplo, se fizer um pedido de lista e receber 100 objetos, terminando com obj_foo, a chamada subsequente pode incluir antes=obj_foo para obter a página anterior da lista.

limit

Um limite para o número de objetos a devolver. O limite pode variar entre 1 e 100 e a predefinição é 20.

order

Ordenar pela created_at carimbo de data/hora dos objetos. asc para ordem ascendente e desc para ordem descendente.

Propriedades Herdadas

abortSignal

O sinal que pode ser utilizado para abortar pedidos.

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação pedida. Pode ser chamado várias vezes.

requestOptions

Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.

tracingOptions

Opções utilizadas quando o rastreio está ativado.

Detalhes de Propriedade

after

Um cursor para utilização na paginação. depois é um ID de objeto que define o seu lugar na lista. Por exemplo, se fizer um pedido de lista e receber 100 objetos, terminando com obj_foo, a chamada subsequente pode incluir after=obj_foo para obter a página seguinte da lista.

after?: string

Valor de Propriedade

string

before

Um cursor para utilização na paginação. antes é um ID de objeto que define o seu lugar na lista. Por exemplo, se fizer um pedido de lista e receber 100 objetos, terminando com obj_foo, a chamada subsequente pode incluir antes=obj_foo para obter a página anterior da lista.

before?: string

Valor de Propriedade

string

limit

Um limite para o número de objetos a devolver. O limite pode variar entre 1 e 100 e a predefinição é 20.

limit?: number

Valor de Propriedade

number

order

Ordenar pela created_at carimbo de data/hora dos objetos. asc para ordem ascendente e desc para ordem descendente.

order?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser utilizado para abortar pedidos.

abortSignal?: AbortSignalLike

Valor de Propriedade

Herdado de OperationOptions.abortSignal

onResponse

Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação pedida. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor de Propriedade

Herdado de OperationOptions.onResponse

requestOptions

Opções utilizadas ao criar e enviar pedidos HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

Herdado de OperationOptions.requestOptions

tracingOptions

Opções utilizadas quando o rastreio está ativado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

Herdado de OperationOptions.tracingOptions