OrganizationExport

Inheritance diagram for OrganizationExport:

Description

An organization export.

See also

https://developers.asana.com/docs/asana-organization-exports

Public Properties
final const	STATE_ACTIVE = 'started'
final const	STATE_FAIL = 'error'
final const	STATE_QUEUED = 'pending'
final const	STATE_SUCCESS = 'finished'
final const	TYPE = 'organization_export'
Public Properties inherited from AbstractEntity
const	TYPE = ''
	All entity classes must redeclare this to match their resource_type. More...

Protected Properties
final const	DIR = 'organization_exports'
const	MAP
Protected Properties inherited from AbstractEntity
const	DIR = ''
	All entity classes must redeclare this to match their REST directory. More...
const	OPT_FIELDS = []
Protected Properties inherited from Data
readonly Api Api	$api
array array self[] AbstractEntity[]	$data = []
array bool[]	$diff = []
const	MAP = []

Public Methods
$this	create (Workspace $organization)
magic string	getCreatedAt ()
	RFC3339x. More...
magic null string	getDownloadUrl ()
magic Workspace	getOrganization ()
magic string	getState ()
bool	isActive ()
	Whether the export is in progress. More...
bool	isDone ()
	Whether the export has completed successfully or failed. More...
bool	isFailed ()
	Whether the export failed. More...
bool	isQueued ()
	Whether the export has yet to be started. More...
bool	isSuccessful ()
	Whether the export completed successfully. More...
$this	wait (callable $spinner=null)
	Sleeps a minute between reloads until the export completes successfully or fails. More...
Public Methods inherited from AbstractEntity
string	__toString ()
	The entity's canonical REST path. More...
null string	getGid ()
bool	hasGid ()
$this	reload ()
	Fully reloads the entity from Asana. More...
Public Methods inherited from Data
mixed	__call (string $method, array $args)
	Magic method handler. More...
	__construct (Api|self $caller, array $data=[])
array	__serialize ()
void	__unserialize (array $data)
bool	isDiff ()
	Whether the instance has changes. More...
array	jsonSerialize ()
bool	offsetExists (mixed $offset)
mixed	offsetGet (mixed $offset)
void	offsetSet (mixed $offset, mixed $value)
void	offsetUnset (mixed $offset)
array	toArray (bool $diff=false)
	Dehydrated data. More...
Public Methods inherited from ImmutableArrayTrait
void	offsetSet (mixed $offset, mixed $value)
	Throws unless overridden. More...
Public Methods inherited from CreateTrait
$this	create ()
	Creates the new entity in Asana. More...
Public Methods inherited from DateTimeTrait
null DateTimeInterface	_getDateTime ()
	Returns a date-time field as an immutable object. More...

Protected Methods
null	_getParentNode ()
Protected Methods inherited from AbstractEntity
mixed	_get (string $field)
	Lazy-loads missing fields. More...
void	_reload (string $field)
void	_setData (array $data)
Protected Methods inherited from Data
bool	_has (string $field)
	Magic method: hasField() More...
T	_hydrate (string $class, $item)
	Sub-data factory that draws from the entity pool. More...
bool	_is (string $field)
	Magic method: isField() More...
bool	_of (string $resourceSubtype)
	Magic method: ofResourceSubtypeValue() More...
array	_select (string|iterable $subject, callable $filter,... $args)
	Magic method: selectField(callable $filter) More...
$this	_set (string $field, $value)
	Magic method: setField(mixed $value) More...
void	_setField (string $field, $value)
	Sets a value, hydrating if mapped, and clears the diff. More...

Properties

MAP

const MAP

protected

Initial value:

= [
        'organization' => Workspace::class
    ]

Methods

_getParentNode()

null _getParentNode ( )

finalprotected

Returns

null

Reimplemented from CreateTrait.

create()

$this create

(

Workspace

$organization

)

Parameters

Workspace

$organization

Returns

$this

getCreatedAt()

magic string getCreatedAt

(

)

RFC3339x.

Returns

string

getDownloadUrl()

magic null string getDownloadUrl

(

)

Returns

null|string

getOrganization()

magic Workspace getOrganization

(

)

Returns

Workspace

getState()

magic string getState

(

)

Returns

string

isActive()

bool isActive ( )

final

Whether the export is in progress.

Returns

bool

isDone()

bool isDone ( )

final

Whether the export has completed successfully or failed.

Returns

bool

isFailed()

bool isFailed ( )

final

Whether the export failed.

Returns

bool

isQueued()

bool isQueued ( )

final

Whether the export has yet to be started.

Returns

bool

isSuccessful()

bool isSuccessful ( )

final

Whether the export completed successfully.

Returns

bool

wait()

$this wait

(

callable

$spinner = null

)

Sleeps a minute between reloads until the export completes successfully or fails.

A spinner can be called every sleep cycle to indicate progress.

Parameters

null | callable

$spinner

fn( OrganizationExport $this ): void

Returns

$this