Skip to content

Commit

Permalink
Sort attributes and methods alphabetically
Browse files Browse the repository at this point in the history
  • Loading branch information
rendertom committed Aug 17, 2020
1 parent 7a539be commit 933d3f6
Show file tree
Hide file tree
Showing 15 changed files with 1,526 additions and 1,604 deletions.
97 changes: 49 additions & 48 deletions 10 - Anywhere object/anywhere.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,179 +11,180 @@ Anywhere object

The **anywhere** object represents any Adobe Anywhere or Team Projects servers available.

----

==========
Attributes
==========

None.

----

=======
Methods
=======

.. _anywhere.getAuthenticationToken:

.. _anywhere.setAuthenticationToken:

setAuthenticationToken
getAuthenticationToken
*********************************************

``anywhere.setAuthenticationToken(token, emailAddress)``
``anywhere.getAuthenticationToken()``

**Description**

Logs the specified email address into the server, using the provided token.
Retrieves an authentication token.

**Parameters**

Takes an authorization ``token``, and the associated email address.
None.

**Returns**

Returns **0** if successful.
A **String** containing the login token, or **0** if unsuccessful.

----

.. _anywhere.getAuthenticationToken:
.. _anywhere.GetCurrentEditingSessionActiveSequenceURL:

getAuthenticationToken
GetCurrentEditingSessionActiveSequenceURL
*********************************************

``anywhere.getAuthenticationToken()``
``anywhere.GetCurrentEditingSessionActiveSequenceURL()``

**Description**

Retrieves an authentication token.
Retrieves the URL of the currently active sequence, within a production.

**Parameters**

None.

**Returns**

A **String** containing the login token, or **0** if unsuccessful.

Returns a **String** containing the asset's URL, or **0** if unsuccessful (including if there is no active sequence, or if no editing session is opened).

----

.. _anywhere.isProductionOpen:
.. _anywhere.GetCurrentEditingSessionSelectionURL:

isProductionOpen
GetCurrentEditingSessionSelectionURL
*********************************************

``anywhere.isProductionOpen()``
``anywhere.GetCurrentEditingSessionSelectionURL()``

**Description**

Retrieves whether an Anywhere or Team Projects production is currently open.
Retrieves the URL of the currently selected single asset. Will fail if more or fewer than one item is selected.

**Parameters**

None.

**Returns**

Returns ``true`` if a production is open; ``false`` if not.
Returns a **String** containing the asset's URL, or **0** if unsuccessful (including if more or fewre than one item is selected).

----

.. _anywhere.listProductions:
.. _anywhere.getCurrentEditingSessionURL:

listProductions
getCurrentEditingSessionURL
*********************************************

``anywhere.listProductions()``
``anywhere.getCurrentEditingSessionURL()``

**Description**

Retrieves production names, available to the current user, on the current server.
Retrieves the URL of the Production, currently being edited.

**Parameters**

None.

**Returns**

Returns an Array of **Strings** containing the names of avialable productions, or 0 if unsuccessful.
Returns a **String** containing the production's URL, or **0** if unsuccessful.

----

.. _anywhere.openProduction:
.. _anywhere.isProductionOpen:

openProduction
isProductionOpen
*********************************************

``anywhere.openProduction(productionURL)``
``anywhere.isProductionOpen()``

**Description**

Opens the production at the specified URL.
Retrieves whether an Anywhere or Team Projects production is currently open.

**Parameters**

A **String** containing the url of the production to open.
None.

**Returns**

Returns **0** if successful.
Returns ``true`` if a production is open; ``false`` if not.

----

.. _anywhere.getCurrentEditingSessionURL:
.. _anywhere.listProductions:

getCurrentEditingSessionURL
listProductions
*********************************************

``anywhere.getCurrentEditingSessionURL()``
``anywhere.listProductions()``

**Description**

Retrieves the URL of the Production, currently being edited.
Retrieves production names, available to the current user, on the current server.

**Parameters**

None.

**Returns**

Returns a **String** containing the production's URL, or **0** if unsuccessful.
Returns an Array of **Strings** containing the names of avialable productions, or 0 if unsuccessful.

----

.. _anywhere.GetCurrentEditingSessionSelectionURL:
.. _anywhere.openProduction:

GetCurrentEditingSessionSelectionURL
openProduction
*********************************************

``anywhere.GetCurrentEditingSessionSelectionURL()``
``anywhere.openProduction(productionURL)``

**Description**

Retrieves the URL of the currently selected single asset. Will fail if more or fewer than one item is selected.
Opens the production at the specified URL.

**Parameters**

None.
A **String** containing the url of the production to open.

**Returns**

Returns a **String** containing the asset's URL, or **0** if unsuccessful (including if more or fewre than one item is selected).
Returns **0** if successful.

----

.. _anywhere.GetCurrentEditingSessionActiveSequenceURL:
.. _anywhere.setAuthenticationToken:

GetCurrentEditingSessionActiveSequenceURL
setAuthenticationToken
*********************************************

``anywhere.GetCurrentEditingSessionActiveSequenceURL()``
``anywhere.setAuthenticationToken(token, emailAddress)``

**Description**

Retrieves the URL of the currently active sequence, within a production.
Logs the specified email address into the server, using the provided token.

**Parameters**

None.
Takes an authorization ``token``, and the associated email address.

**Returns**

Returns a **String** containing the asset's URL, or **0** if unsuccessful (including if there is no active sequence, or if no editing session is opened).
Returns **0** if successful.

0 comments on commit 933d3f6

Please sign in to comment.