Skip to main content Skip to complementary content

SearchObjectsAsync Method

Overloads

SearchObjectsAsync(SearchObjectOptions, IEnumerable<String>, SearchPage)

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

SearchObjectsAsync(AsyncHandle, SearchObjectOptions, IEnumerable<String>, SearchPage)

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

SearchObjectsAsync<T>(AsyncHandle, Func<Response, T>, SearchObjectOptions, IEnumerable<String>, SearchPage)

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

SearchObjectsAsync(SearchObjectOptions, IEnumerable<String>, SearchPage)

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

Declaration

      public Task<SearchResult> SearchObjectsAsync([QixName("qOptions")] SearchObjectOptions options, [QixName("qTerms")] IEnumerable<string> terms, [QixName("qPage")] SearchPage page)
    

Parameters

Type Name Description
SearchObjectOptions options

Information about attributes.

System.Collections.Generic.IEnumerable<System.String> terms

Terms to search for.

SearchPage page

Array of pages to retrieve.

Returns

Type Description
System.Threading.Tasks.Task<SearchResult>

Implements

SearchObjectsAsync(AsyncHandle, SearchObjectOptions, IEnumerable<String>, SearchPage)

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

Declaration

      public Task<SearchResult> SearchObjectsAsync(AsyncHandle asyncHandle, [QixName("qOptions")] SearchObjectOptions options, [QixName("qTerms")] IEnumerable<string> terms, [QixName("qPage")] SearchPage page)
    

Parameters

Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

SearchObjectOptions options

Information about attributes.

System.Collections.Generic.IEnumerable<System.String> terms

Terms to search for.

SearchPage page

Array of pages to retrieve.

Returns

Type Description
System.Threading.Tasks.Task<SearchResult>

Implements

SearchObjectsAsync<T>(AsyncHandle, Func<Response, T>, SearchObjectOptions, IEnumerable<String>, SearchPage)

Returns the generic objects corresponding to one or more search terms. The search is performed within the title, subtitle, footnote and type. In addition, associated dimension values are also searched in. For example, if the country “Japan” is selected and the object contains the dimension City, the object will appear in the results for “Osaka” but not for “Johannesburg”. The generic objects with the following types will never appear in the results: slideitem , sheet , story , slide , masterobject , snapshot , LoadModel , appprops and searchhistory .

Declaration

      public Task<T> SearchObjectsAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qOptions")] SearchObjectOptions options, [QixName("qTerms")] IEnumerable<string> terms, [QixName("qPage")] SearchPage page)
    

Parameters

Type Name Description
AsyncHandle asyncHandle

Handle to asynchronous method request

System.Func<Response, T> onResult

Continuation function

SearchObjectOptions options

Information about attributes.

System.Collections.Generic.IEnumerable<System.String> terms

Terms to search for.

SearchPage page

Array of pages to retrieve.

Returns

Type Description
System.Threading.Tasks.Task<T>

Type Parameters

Name Description
T

Implements

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!