PHP Class Zendesk\API\Resources\Core\Apps

Inheritance: extends Zendesk\API\Resources\ResourceAbstract, use trait Zendesk\API\Traits\Utility\InstantiatorTrait, use trait Zendesk\API\Traits\Resource\Find, use trait Zendesk\API\Traits\Resource\Delete, use trait Zendesk\API\Traits\Resource\MultipartUpload
Show file Open project: zendesk/zendesk_api_client_php

Public Methods

Method Description
create ( array $params ) : stdClass Create an app
findAllOwned ( array $params = [] ) : stdClass Lists apps owned by the current account.
getUploadName ( )
getUploadRequestMethod ( ) {$@inheritdoc}
getValidSubResources ( )
install ( array $params ) : stdClass Installs an App on the account. app_id is required, as is a settings hash containing keys for all required parameters for the app.
jobStatus ( array $params ) : stdClass Queries the application build job status using a job id given from the job creation step.
notify ( array $params ) : stdClass The notify endpoint allows you to send messages to currently-open instances of an app.
update ( null $id = null, array $params = [] ) : stdClass Update an app

Protected Methods

Method Description
setUpRoutes ( )

Method Details

create() public method

Create an app
public create ( array $params ) : stdClass
$params array
return stdClass | null

findAllOwned() public method

Lists apps owned by the current account.
public findAllOwned ( array $params = [] ) : stdClass
$params array
return stdClass | null

getUploadName() public method

public getUploadName ( )

getUploadRequestMethod() public method

{$@inheritdoc}
public getUploadRequestMethod ( )

getValidSubResources() public static method

public static getValidSubResources ( )

install() public method

Any values in settings that don't correspond to a parameter that the app declares will be silently ignored.
public install ( array $params ) : stdClass
$params array
return stdClass | null

jobStatus() public method

Queries the application build job status using a job id given from the job creation step.
public jobStatus ( array $params ) : stdClass
$params array
return stdClass | null

notify() public method

For example, you could send a message to all logged-in agents telling them to take the day off.
public notify ( array $params ) : stdClass
$params array
return stdClass | null

setUpRoutes() protected method

protected setUpRoutes ( )

update() public method

Update an app
public update ( null $id = null, array $params = [] ) : stdClass
$id null
$params array
return stdClass | null