Documentation

ChannelsApi extends ResourceApiNoDelete
in package

V3ApiBase

Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement

Tags

Table of Contents

INCLUDE__CURRENCIES  = 'currencies'
__construct()  : mixed
create()  : ChannelResponse
currencyAssignments()  : ChannelCurrencyAssignmentsApi
delete()  : ResponseInterface
get()  : ChannelResponse
getActiveTheme()  : ChannelActiveThemeResponse
getAll()  : ChannelsResponse
getClient()  : Client
getParentResourceId()  : int|null
getResourceId()  : int|null
listing()  : ChannelListingsApi
listings()  : ChannelListingsApi
multipleResourceUrl()  : string
singleResourceUrl()  : string
site()  : ChannelSitesApi
update()  : ChannelResponse

Constants

INCLUDE__CURRENCIES

public mixed INCLUDE__CURRENCIES = 'currencies'
Tags

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 —

delete()

public delete() : ResponseInterface
Tags
Return values
ResponseInterface —

getAll()

public getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : ChannelsResponse
Parameters
$filters : array<string|int, mixed> = []
$page : int = 1
$limit : int = 250
Tags
Return values
ChannelsResponse —

getParentResourceId()

public getParentResourceId() : int|null
Tags
Return values
int|null —

getResourceId()

public getResourceId() : int|null
Tags
Return values
int|null —

multipleResourceUrl()

public abstract multipleResourceUrl() : string
Tags
Return values
string —

singleResourceUrl()

public abstract singleResourceUrl() : string
Tags
Return values
string — 

        

        
    




    

    

                

    

        

            
Search results