DistributionApi
extends AbstractApi
in package
Distribution is a CDN vault that mirrors your project’s translated content and is required for integration with the iOS, Android, or Web apps.
Table of Contents
Methods
- create() : Distribution|null
- Add Distribution
- delete() : mixed
- Delete Distribution
- get() : Distribution|null
- Get Distribution
- getRelease() : DistributionRelease|null
- Get Distribution Release
- list() : ModelCollection
- List Distributions
- release() : DistributionRelease|null
- Release Distribution
- update() : Distribution|null
- Edit Distribution
Methods
create()
Add Distribution
public
create(int $projectId, array<string|int, mixed> $data) : Distribution|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
string $data[exportMode] Enum: "default" "bundle" Default: "default"
string $data[name] required
int[] $data[fileIds] required
string $data[format] required for 'bundle' export mode
string $data[exportPattern] required for 'bundle' export mode. Note: Can't contain \ / : * ? " < > | symbols
int[] $data[labelIds]
Tags
Return values
Distribution|nulldelete()
Delete Distribution
public
delete(int $projectId, string $hash) : mixed
Parameters
- $projectId : int
- $hash : string
Tags
get()
Get Distribution
public
get(int $projectId, string $hash) : Distribution|null
Parameters
- $projectId : int
- $hash : string
Tags
Return values
Distribution|nullgetRelease()
Get Distribution Release
public
getRelease(int $projectId, string $hash) : DistributionRelease|null
Parameters
- $projectId : int
- $hash : string
Tags
Return values
DistributionRelease|nulllist()
List Distributions
public
list(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit] [ 1 .. 500 ] Default: 25
integer $params[offset] >= 0 Default: 0
Tags
Return values
ModelCollectionrelease()
Release Distribution
public
release(int $projectId, string $hash) : DistributionRelease|null
Parameters
- $projectId : int
- $hash : string
Tags
Return values
DistributionRelease|nullupdate()
Edit Distribution
public
update(int $projectId, Distribution $distribution) : Distribution|null
Parameters
- $projectId : int
- $distribution : Distribution