• Preparing search index...
  • The search index is not available
@esri/solution.js
  • @esri/solution.js
  • common/src
  • searchGroups

Function searchGroups

  • searchGroups(searchString, authentication, additionalSearchOptions?): Promise<ISearchResult<IGroup>>
  • Searches for groups matching criteria.

    Parameters

    • searchString: string

      Text for which to search, e.g., 'redlands+map', 'type:"Web Map" -type:"Web Mapping Application"'

    • authentication: UserSession

      Credentials for the request to AGO

    • Optional additionalSearchOptions: IAdditionalGroupSearchOptions

      Adjustments to search, such as tranche size

    Returns Promise<ISearchResult<IGroup>>

    A promise that will resolve with a structure with a tranche of results and describing how many items are available

    See

    • https://developers.arcgis.com/rest/users-groups-and-items/group-search.htm
    • https://developers.arcgis.com/rest/users-groups-and-items/search-reference.htm
    • Defined in packages/common/src/restHelpers.ts:1536

Settings

Member Visibility

Theme

@esri/solution.js
  • Loading...

Generated using TypeDoc