PagesApi
extends ResourceWithBatchUpdateApi
in package
Uses
BatchCreateResource
Includes the multiple and single page requests for pages
Tags
Table of Contents
- __construct() : mixed
- batchCreate() : PagesResponse
- batchDelete() : bool
- batchUpdate() : PagesResponse
- create() : PageResponse
- delete() : ResponseInterface
- get() : PageResponse
- getAll() : PagesResponse
- getClient() : Client
- getMaxRetries() : int
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- setMaxRetries() : void
- singleResourceUrl() : string
- update() : PageResponse
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 —batchCreate()
public
batchCreate(array<string|int, mixed> $resources) : PagesResponse
Parameters
- $resources : array<string|int, mixed>
Tags
Return values
PagesResponse —batchDelete()
public
batchDelete([array<string|int, mixed> $ids = [] ]) : bool
Parameters
- $ids : array<string|int, mixed> = []
Tags
Return values
bool —batchUpdate()
public
batchUpdate(array<string|int, mixed> $resources) : PagesResponse
Parameters
- $resources : array<string|int, mixed>
Tags
Return values
PagesResponse —create()
public
create(Page $page) : PageResponse
Parameters
- $page : Page
Tags
Return values
PageResponse —delete()
public
delete() : ResponseInterface
Tags
Return values
ResponseInterface —get()
public
get() : PageResponse
Tags
Return values
PageResponse —getAll()
public
getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : PagesResponse
Parameters
- $filters : array<string|int, mixed> = []
- $page : int = 1
- $limit : int = 250
Tags
Return values
PagesResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getMaxRetries()
public
getMaxRetries() : int
Tags
Return values
int —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 —setMaxRetries()
public
setMaxRetries(int $maxRetries) : void
Parameters
- $maxRetries : int
Tags
Return values
void —singleResourceUrl()
public
abstract singleResourceUrl() : string
Tags
Return values
string —update()
public
update(Page $page) : PageResponse
Parameters
- $page : Page