/
PollerOptions.yml
126 lines (124 loc) · 4.48 KB
/
PollerOptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
### YamlMime:TSType
name: PollerOptions
uid: '@azure/ai-form-recognizer.PollerOptions'
package: '@azure/ai-form-recognizer'
summary: Options for long-running operations (pollers) in the Form Recognizer clients.
fullName: PollerOptions<TState>
remarks: ''
isDeprecated: false
type: interface
properties:
- name: onProgress
uid: '@azure/ai-form-recognizer.PollerOptions.onProgress'
package: '@azure/ai-form-recognizer'
summary: >-
An optional initial progress handler that will be called when the poller
state updates. This handler will be called
once immediately after the poller state is initialized.
fullName: onProgress
remarks: ''
isDeprecated: false
syntax:
content: 'onProgress?: (state: TState) => void'
return:
description: ''
type: '(state: TState) => void'
- name: resumeFrom
uid: '@azure/ai-form-recognizer.PollerOptions.resumeFrom'
package: '@azure/ai-form-recognizer'
summary: >-
A serialized poller state. If provided, the polling operation will be
resumed from the given state instead of
started as if it were a new operation.
fullName: resumeFrom
remarks: ''
isDeprecated: false
syntax:
content: 'resumeFrom?: string'
return:
description: ''
type: string
- name: updateIntervalInMs
uid: '@azure/ai-form-recognizer.PollerOptions.updateIntervalInMs'
package: '@azure/ai-form-recognizer'
summary: >-
The amount of time to wait (in milliseconds) between subsequent requests
relating to the same operation.
fullName: updateIntervalInMs
remarks: ''
isDeprecated: false
syntax:
content: 'updateIntervalInMs?: number'
return:
description: ''
type: number
inheritedProperties:
- name: abortSignal
uid: '@azure/ai-form-recognizer.PollerOptions.abortSignal'
package: '@azure/ai-form-recognizer'
summary: The signal which can be used to abort requests.
fullName: abortSignal
remarks: ''
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
description: ''
type: <xref uid="@azure/abort-controller.AbortSignalLike" />
inheritanceDescription: <b>Inherited From</b> OperationOptions.abortSignal
- name: onResponse
uid: '@azure/ai-form-recognizer.PollerOptions.onResponse'
package: '@azure/ai-form-recognizer'
summary: |-
A function to be called each time a response is received from the server
while performing the requested operation.
May be called multiple times.
fullName: onResponse
remarks: ''
isDeprecated: false
syntax:
content: 'onResponse?: RawResponseCallback'
return:
description: ''
type: <xref uid="@azure/core-client.RawResponseCallback" />
inheritanceDescription: <b>Inherited From</b> OperationOptions.onResponse
- name: requestOptions
uid: '@azure/ai-form-recognizer.PollerOptions.requestOptions'
package: '@azure/ai-form-recognizer'
summary: Options used when creating and sending HTTP requests for this operation.
fullName: requestOptions
remarks: ''
isDeprecated: false
syntax:
content: 'requestOptions?: OperationRequestOptions'
return:
description: ''
type: <xref uid="@azure/core-client.OperationRequestOptions" />
inheritanceDescription: <b>Inherited From</b> OperationOptions.requestOptions
- name: serializerOptions
uid: '@azure/ai-form-recognizer.PollerOptions.serializerOptions'
package: '@azure/ai-form-recognizer'
summary: Options to override serialization/de-serialization behavior.
fullName: serializerOptions
remarks: ''
isDeprecated: false
syntax:
content: 'serializerOptions?: SerializerOptions'
return:
description: ''
type: <xref uid="@azure/core-client.SerializerOptions" />
inheritanceDescription: <b>Inherited From</b> OperationOptions.serializerOptions
- name: tracingOptions
uid: '@azure/ai-form-recognizer.PollerOptions.tracingOptions'
package: '@azure/ai-form-recognizer'
summary: Options used when tracing is enabled.
fullName: tracingOptions
remarks: ''
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
description: ''
type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
inheritanceDescription: <b>Inherited From</b> OperationOptions.tracingOptions
extends: <xref uid="@azure/core-client.OperationOptions" />