WidgetServiceClient class

Oluşturucular

WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)
WidgetServiceClient(string, WidgetServiceClientOptions)

Yöntemler

analyzeWidget(string, AnalyzeWidgetOptions)

Pencere öğesini analiz etme. Tek garanti, bu yöntemin çözümleme sonuçlarını içeren bir dize döndürmesidir.

createWidget(number, ColorType, CreateWidgetOptions)

Yeni bir pencere öğesi oluşturun.

Pencere öğesi kimliği, sunucu tarafından otomatik olarak ayarlandığından oluşturma sırasında gerekli değildir. Kimlik sağlanması hataya neden olur.

deleteWidget(string, DeleteWidgetOptions)

Bir pencere öğesini kimliğine göre silin.

getWidget(string, GetWidgetOptions)

Kimliğine göre bir pencere öğesi alın.

listWidgets(ListWidgetsOptions)

Sistemdeki tüm pencere öğelerini listeleyin. Bu işlem sayfalandırılmış değildir ve basit bir pencere öğesi dizisi döndürür.

Hiçbir seçeneği veya parametreyi kabul etmez.

updateWidget(string, UpdateWidgetOptions)

Pencere öğesinin içeriğini güncelleştirin. Girişte pencere öğesi kimliği gereklidir, ancak değiştirilemez. Diğer tüm alanlar isteğe bağlıdır ve sağlanırsa pencere öğesi içinde güncelleştirilir.

Oluşturucu Ayrıntıları

WidgetServiceClient(string, TokenCredential, WidgetServiceClientOptions)

new WidgetServiceClient(endpoint: string, credential: TokenCredential, options?: WidgetServiceClientOptions)

Parametreler

endpoint

string

credential
TokenCredential

WidgetServiceClient(string, WidgetServiceClientOptions)

new WidgetServiceClient(endpoint: string, options?: WidgetServiceClientOptions)

Parametreler

endpoint

string

Yöntem Ayrıntıları

analyzeWidget(string, AnalyzeWidgetOptions)

Pencere öğesini analiz etme. Tek garanti, bu yöntemin çözümleme sonuçlarını içeren bir dize döndürmesidir.

function analyzeWidget(id: string, options?: AnalyzeWidgetOptions): Promise<AnalyzeResult>

Parametreler

id

string

Döndürülenler

Promise<AnalyzeResult>

createWidget(number, ColorType, CreateWidgetOptions)

Yeni bir pencere öğesi oluşturun.

Pencere öğesi kimliği, sunucu tarafından otomatik olarak ayarlandığından oluşturma sırasında gerekli değildir. Kimlik sağlanması hataya neden olur.

function createWidget(weight: number, color: ColorType, options?: CreateWidgetOptions): Promise<Widget>

Parametreler

weight

number

color
ColorType

Döndürülenler

Promise<Widget>

deleteWidget(string, DeleteWidgetOptions)

Bir pencere öğesini kimliğine göre silin.

function deleteWidget(id: string, options?: DeleteWidgetOptions): Promise<void>

Parametreler

id

string

Döndürülenler

Promise<void>

getWidget(string, GetWidgetOptions)

Kimliğine göre bir pencere öğesi alın.

function getWidget(id: string, options?: GetWidgetOptions): Promise<Widget>

Parametreler

id

string

Döndürülenler

Promise<Widget>

listWidgets(ListWidgetsOptions)

Sistemdeki tüm pencere öğelerini listeleyin. Bu işlem sayfalandırılmış değildir ve basit bir pencere öğesi dizisi döndürür.

Hiçbir seçeneği veya parametreyi kabul etmez.

function listWidgets(options?: ListWidgetsOptions): Promise<Widget[]>

Parametreler

Döndürülenler

Promise<Widget[]>

updateWidget(string, UpdateWidgetOptions)

Pencere öğesinin içeriğini güncelleştirin. Girişte pencere öğesi kimliği gereklidir, ancak değiştirilemez. Diğer tüm alanlar isteğe bağlıdır ve sağlanırsa pencere öğesi içinde güncelleştirilir.

function updateWidget(id: string, options?: UpdateWidgetOptions): Promise<Widget>

Parametreler

id

string

Döndürülenler

Promise<Widget>