WidgetServiceClient class
コンストラクター
| Widget |
|
| Widget |
メソッド
| analyze |
ウィジェットを分析します。 唯一の保証は、このメソッドが分析の結果を含む文字列を返すということです。 |
| create |
新しいウィジェットを作成します。 ウィジェット ID は、サーバーによって自動的に設定されるため、作成時には必要ありません。 ID を指定すると、エラーが発生します。 |
| delete |
ID でウィジェットを削除します。 |
| get |
ID でウィジェットを取得します。 |
| list |
システム内のすべてのウィジェットを一覧表示します。 この操作はページ分割されず、ウィジェットの単純な配列を返します。 オプションやパラメーターは受け入れられません。 |
| update |
ウィジェットの内容を更新します。 ウィジェット ID は入力に必要ですが、変更することはできません。 他のすべてのフィールドは省略可能であり、指定された場合はウィジェット内で更新されます。 |
コンストラクターの詳細
WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)
new WidgetServiceClient(endpoint: string, credential: TokenCredential, options?: WidgetServiceClientOptions)パラメーター
- endpoint
-
string
- credential
- TokenCredential
- options
- WidgetServiceClientOptions
WidgetServiceClient(string, WidgetServiceClientOptions)
new WidgetServiceClient(endpoint: string, options?: WidgetServiceClientOptions)パラメーター
- endpoint
-
string
- options
- WidgetServiceClientOptions
メソッドの詳細
analyzeWidget(string, AnalyzeWidgetOptions)
ウィジェットを分析します。 唯一の保証は、このメソッドが分析の結果を含む文字列を返すということです。
function analyzeWidget(id: string, options?: AnalyzeWidgetOptions): Promise<AnalyzeResult>パラメーター
- id
-
string
- options
- AnalyzeWidgetOptions
戻り値
Promise<AnalyzeResult>
createWidget(number, ColorType, CreateWidgetOptions)
新しいウィジェットを作成します。
ウィジェット ID は、サーバーによって自動的に設定されるため、作成時には必要ありません。 ID を指定すると、エラーが発生します。
function createWidget(weight: number, color: ColorType, options?: CreateWidgetOptions): Promise<Widget>パラメーター
- weight
-
number
- color
- ColorType
- options
- CreateWidgetOptions
戻り値
Promise<Widget>
deleteWidget(string, DeleteWidgetOptions)
ID でウィジェットを削除します。
function deleteWidget(id: string, options?: DeleteWidgetOptions): Promise<void>パラメーター
- id
-
string
- options
- DeleteWidgetOptions
戻り値
Promise<void>
getWidget(string, GetWidgetOptions)
ID でウィジェットを取得します。
function getWidget(id: string, options?: GetWidgetOptions): Promise<Widget>パラメーター
- id
-
string
- options
- GetWidgetOptions
戻り値
Promise<Widget>
listWidgets(ListWidgetsOptions)
システム内のすべてのウィジェットを一覧表示します。 この操作はページ分割されず、ウィジェットの単純な配列を返します。
オプションやパラメーターは受け入れられません。
function listWidgets(options?: ListWidgetsOptions): Promise<Widget[]>パラメーター
- options
- ListWidgetsOptions
戻り値
Promise<Widget[]>
updateWidget(string, UpdateWidgetOptions)
ウィジェットの内容を更新します。 ウィジェット ID は入力に必要ですが、変更することはできません。 他のすべてのフィールドは省略可能であり、指定された場合はウィジェット内で更新されます。
function updateWidget(id: string, options?: UpdateWidgetOptions): Promise<Widget>パラメーター
- id
-
string
- options
- UpdateWidgetOptions
戻り値
Promise<Widget>
Azure SDK for JavaScript