`describeSearchScopeOrder()`

Retrieves an ordered list of the objects in a user’s default global search scope.

Syntax

1DescribeSearchScopeOrderResult[] describeSearchScopeOrderResults = connection.describeSearchScopeOrder();

Usage

Use describeSearchScopeOrder() to retrieve an ordered list of objects in the default global search scope of a logged-in user. Global search tracks the objects the user interacts with and how often and arranges the search results accordingly. Objects used most frequently appear at the top of the list. The returned list reflects the object order in the user’s default search scope, including any pinned objects on the user’s search results page. This call is useful if you want to implement a custom search results page using the optimized global search scope.

You must enable Chatter to enable global search.

Note

Sample Code—Java

This sample shows how to retrieve the global search scope for a user and then iteratively display the name of each object in the scope.

1public void describeSearchScopeOrderSample() { 
2  try { 
3    //Get the order of objects in search smart scope for the logged-in user
4    DescribeSearchScopeOrderResult[] describeSearchScopeOrderResults = 
5        connection.describeSearchScopeOrder();
6    //Iterate through the results and display the name of each object
7    for (int i = 0; i < describeSearchScopeOrderResults.length; i++) {
8      System.out.println(describeSearchScopeOrderResults[i].getName());
9    }
10  } 
11  catch(ConnectionException ce) {
12    ce.printStackTrace();
13  }
14}

Arguments

None.

Response

An array of DescribeSearchScopeOrderResult objects

Fault

UnexpectedErrorFault

See Also

API Call Basics