Compartilhar via


ListMessagesOptions interface

Os detalhes usados para listar mensagens.

Extends

Propriedades

after

Um cursor para uso na paginação. depois é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir after=obj_foo para buscar a próxima página da lista.

before

Um cursor para uso na paginação. antes é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir before=obj_foo para buscar a página anterior da lista.

limit

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o padrão é 20.

order

Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente e desc para ordem decrescente.

Propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

onResponse

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

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para essa operação.

tracingOptions

Opções usadas quando o rastreamento está habilitado.

Detalhes da propriedade

after

Um cursor para uso na paginação. depois é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir after=obj_foo para buscar a próxima página da lista.

after?: string

Valor da propriedade

string

before

Um cursor para uso na paginação. antes é uma ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir before=obj_foo para buscar a página anterior da lista.

before?: string

Valor da propriedade

string

limit

Um limite no número de objetos a serem retornados. O limite pode variar entre 1 e 100 e o padrão é 20.

limit?: number

Valor da propriedade

number

order

Classificar a ordem pelo carimbo de data/hora created_at dos objetos. asc para ordem crescente e desc para ordem decrescente.

order?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

abortSignal

O sinal que pode ser usado para anular solicitações.

abortSignal?: AbortSignalLike

Valor da 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 solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor da propriedade

Herdado de OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para essa operação.

requestOptions?: OperationRequestOptions

Valor da propriedade

Herdado de OperationOptions.requestOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor da propriedade

Herdado de OperationOptions.tracingOptions