ChannelSitesApi
extends V3ApiBase
in package
Uses
GetResource, DeleteResource, CreateResource, UpdateResource
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Tags
Table of Contents
- __construct() : mixed
- create() : ChannelSiteResponse
- delete() : ResponseInterface
- get() : ChannelSiteResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- route() : SiteRoutesApi
- routes() : SiteRoutesApi
- singleResourceUrl() : string
- update() : ChannelSiteResponse
Methods
__construct()
public
__construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : Client
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Tags
Return values
mixed —create()
public
create(ChannelSite $site) : ChannelSiteResponse
Parameters
- $site : ChannelSite
Tags
Return values
ChannelSiteResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : ChannelSiteResponse
Tags
Return values
ChannelSiteResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —multipleResourceUrl()
public
multipleResourceUrl() : string
Tags
Return values
string —route()
public
route(int $id) : SiteRoutesApi
Parameters
- $id : int
Tags
Return values
SiteRoutesApi —routes()
public
routes() : SiteRoutesApi
Tags
Return values
SiteRoutesApi —singleResourceUrl()
public
singleResourceUrl() : string
Tags
Return values
string —update()
public
update(ChannelSite $site) : ChannelSiteResponse
Parameters
- $site : ChannelSite