PHP Class Zendesk\API\Resources\Core\Search

Inheritance: extends Zendesk\API\Resources\ResourceAbstract
Show file Open project: zendesk/zendesk_api_client_php

Public Methods

Method Description
anonymous ( $query, array $queryParams = [] ) : stdClass This resource behaves the same as /api/v2/search, but lets anonymous users search public forums in the Web portal. The endpoint searches only articles, not tickets, and returns only articles that the requesting user is allowed to see.
find ( null $query = null, array $queryParams = [] ) : stdClass The search API is a unified search API that returns tickets, users, and organizations. You can define filters to narrow your search results according to resource type, dates, and object properties, such as ticket requester or tag.

Protected Methods

Method Description
setUpRoutes ( )

Method Details

anonymous() public method

This resource behaves the same as /api/v2/search, but lets anonymous users search public forums in the Web portal. The endpoint searches only articles, not tickets, and returns only articles that the requesting user is allowed to see.
public anonymous ( $query, array $queryParams = [] ) : stdClass
$query
$queryParams array
return stdClass | null

find() public method

The search API is a unified search API that returns tickets, users, and organizations. You can define filters to narrow your search results according to resource type, dates, and object properties, such as ticket requester or tag.
public find ( null $query = null, array $queryParams = [] ) : stdClass
$query null
$queryParams array
return stdClass | null

setUpRoutes() protected method

protected setUpRoutes ( )