Documentation

CustomTemplateAssociationsApi extends V3ApiBase
in package
Uses GetAllResources, BatchUpdateResource

V3ApiBase

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

Tags

Table of Contents

DELETE_QUERY_CHANNEL_ID  = 'channel_id'
DELETE_QUERY_ENTITY_ID_IN  = 'entity_id:in'
DELETE_QUERY_ID_IN  = 'id:in'
DELETE_QUERY_TYPE  = 'type'
FILTER_CHANNEL_ID  = 'channel_id'
FILTER_ENTITY_ID_IN  = 'entity_id:in'
FILTER_IS_VALID  = 'is_valid'
FILTER_TYPE  = 'type'
__construct()  : mixed
batchUpdate()  : CustomTemplateAssociationsResponse
delete()  : void
deleteByChannelId()  : void
deleteByEntityIds()  : void
deleteByIds()  : void
getAll()  : CustomTemplateAssociationsResponse
getClient()  : Client
getMaxRetries()  : int
getParentResourceId()  : int|null
getResourceId()  : int|null
multipleResourcesEndpoint()  : string
multipleResourceUrl()  : string
setMaxRetries()  : void

Constants

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(array<string|int, mixed> $query) : void
Parameters
$query : array<string|int, mixed>
Tags
Return values
void —

deleteByChannelId()

public deleteByChannelId(int $channelId) : void
Parameters
$channelId : int
Tags
Return values
void —

deleteByEntityIds()

public deleteByEntityIds(string $type, array<string|int, mixed> $ids) : void
Parameters
$type : string
$ids : array<string|int, mixed>
Tags
Return values
void —

deleteByIds()

public deleteByIds(array<string|int, mixed> $ids) : void
Parameters
$ids : array<string|int, mixed>
Tags
Return values
void —

getParentResourceId()

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

getResourceId()

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

setMaxRetries()

public setMaxRetries(int $maxRetries) : void
Parameters
$maxRetries : int
Tags
Return values
void — 

        

        
    




    

    

                

    

        

            
Search results