PHP Class Zendesk\API\Resources\Core\Sessions

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

Protected Properties

Property Type Description
$resourceName

Public Methods

Method Description
current ( ) : stdClass Shows the currently authenticated session
deleteUserSessions ( null $userId = null ) : null Deletes all the sessions for a user.
getRoute ( $name, array $params = [] ) : mixed Returns a route and replaces tokenized parts of the string with the passed params
logout ( ) : null Deletes the current session.

Protected Methods

Method Description
setUpRoutes ( )

Method Details

current() public method

Shows the currently authenticated session
public current ( ) : stdClass
return stdClass | null

deleteUserSessions() public method

Deletes all the sessions for a user.
public deleteUserSessions ( null $userId = null ) : null
$userId null
return null

getRoute() public method

Returns a route and replaces tokenized parts of the string with the passed params
public getRoute ( $name, array $params = [] ) : mixed
$name
$params array
return mixed The default routes, or if $name is set to `findAll`, any of the following formats based on the parent chain /api/v2/sessions.json /api/v2/users/{userId}/sessions.json

logout() public method

Deletes the current session.
public logout ( ) : null
return null

setUpRoutes() protected method

protected setUpRoutes ( )

Property Details

$resourceName protected property

protected $resourceName