Newer Version Available

This content describes an older version of this product. View Latest

Sites Class

Search an Experience Cloud site.

Namespace

ConnectApi

Sites Methods

The following are methods for Sites. All methods are static.

searchSite(siteId, queryTerm, pageToken, pageSize, language) (Beta)

Search an Experience Cloud site.

API Version

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Note

54.0

Available to Guest Users

54.0

Requires Chatter

No

Signature

public static ConnectApi.SiteSearchResult searchSite(String siteId, String queryTerm, String pageToken, Integer pageSize, String language)

Parameters

siteId
Type: String
ID for the Experience Cloud site.
queryTerm
Type: String
Term used to search for relevant content. Provide up to 32 terms with a maximum of 1024 characters including white space. Logical operators aren’t supported.
pageToken
Type: String
Specifies the base64 encoded page token. Page tokens are returned as part of the response. If unspecified, the first page is returned.
pageSize
Type: Integer
Specifies the number of items per page. Valid values are from 1 through 240. If you pass in null, the default size is 25.
language
Type: String
Language locale for the context user. If unspecified or if the specified language locale isn’t available, the default value is en_US.

Return Value

Type: ConnectApi.SiteSearchResult