queryLabels( )


開発者プレビュー

このAPIは変更される可能性があります。プレビュー期間中、開発者からのフィードバックに基づいてバグ修正や新機能がリリースされる予定です。

Creates a query to retrieve a list of labels.

について queryLabels() function builds a query to retrieve a list of labels and returns a LabelsQueryBuilder オブジェクトがある。

The returned object contains the query definition, which is used to run the query using the find() 関数である。

You can refine the query by chaining LabelsQueryBuilder functions onto the query. LabelsQueryBuilder functions enable you to filter, sort, and control the results that queryLabels() returns.

queryLabels() runs with the following LabelsQueryBuilder defaults, which you can override:

  • skip(0)
  • limit(50)
  • descending('_createdDate')

The following LabelsQueryBuilder functions are supported for queryLabels(). For a full description of the Labels object, see the object returned for the 項目 property in LabelsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
namespaceeq(),ne()
keyeq(),ne(),in()
displayNameeq(),ne(),in(),startsWith(),昇順(),降順()
labelTypeeq()
_createdDateeq(),ne(),gt(),lt(),ge(),ル(),昇順(),降順()
_updatedDateeq(),ne(),gt(),lt(),ge(),ル(),昇順(),降順()
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Contact Labels
Manage Portfolio
Manage Members and Contacts - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
メソッド宣言
コピー
メソッド・パラメータ
optionsQueryLabelsOptions

Language options.

リターン
Return Type:LabelsQueryBuilder
役に立ちましたか?
はい
いいえ