次の方法で共有


FavoritesListOptionalParams interface

省略可能なパラメーター。

Extends

プロパティ

canFetchContent

該当する各お気に入りの完全なコンテンツを返すかどうかを示すフラグ。 false の場合は、お気に入りの概要コンテンツのみを返します。

favoriteType

お気に入りの種類。 値には、共有またはユーザーを指定できます。 使用可能な値は、'shared'、'user' です。 既定値は 'shared' です。

sourceType

返すお気に入りのソースの種類。 省略すると、ソースの種類は既定で 'other' になります (この列挙型には存在しません)。 使用できる値は、'retention'、'notebook'、'sessions'、'events'、'userflows'、'funnel'、'impact'、'segmentation' です。

tags

返される各お気に入りに存在する必要があるタグ。

継承されたプロパティ

abortSignal

要求を中止するために使用できるシグナル。

customHeaders

要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onUploadProgress

アップロードの進行状況時に発生するコールバック。

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

canFetchContent

該当する各お気に入りの完全なコンテンツを返すかどうかを示すフラグ。 false の場合は、お気に入りの概要コンテンツのみを返します。

canFetchContent?: boolean

プロパティ値

boolean

favoriteType

お気に入りの種類。 値には、共有またはユーザーを指定できます。 使用可能な値は、'shared'、'user' です。 既定値は 'shared' です。

favoriteType?: FavoriteType

プロパティ値

sourceType

返すお気に入りのソースの種類。 省略すると、ソースの種類は既定で 'other' になります (この列挙型には存在しません)。 使用できる値は、'retention'、'notebook'、'sessions'、'events'、'userflows'、'funnel'、'impact'、'segmentation' です。

sourceType?: FavoriteSourceType

プロパティ値

tags

返される各お気に入りに存在する必要があるタグ。

tags?: string[]

プロパティ値

string[]

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

msRest.RequestOptionsBase.abortSignal から継承

customHeaders

要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。

customHeaders?: {[key: string]: string}

プロパティ値

{[key: string]: string}

msRest.RequestOptionsBase.customHeaders から継承

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

msRest.RequestOptionsBase.onDownloadProgress から継承

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

msRest.RequestOptionsBase.onUploadProgress から継承

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

timeout?: number

プロパティ値

number

msRest.RequestOptionsBase.timeout から継承