Target Object

Document created by DPM Admin on Jul 21, 2017Last modified by Trishala Kalal on Aug 14, 2017
Version 2Show Document
  • View in full screen mode

Represents the target itself.

Target Properties

  • name (string)

The name of this item. An item’s name can be changed by setting this property, with the following restrictions:

  • The name can only be changed before any activity has occurred for the given item. The item cannot have started playing yet, cannot have started repeating yet, and no other actions for it can have occurred yet (e.g. no other properties of it can have been set).
  • The name specified by the script must, of course, be a legal item name (255 chars max, no square brackets or slashes), and must not be the same name as another item in the same container.
  • parent (object)

The parent object of this item.

  • propertyList (object)
A PropertyList object that allows access to all of the Custom Properties contained in this object.
  • systempropertyList (read only – object)

A SystemPropertyList object that allows access to all of the System Properties contained in this object.

  • type (string)

A string that indicates the type of this object.

  • children (array of objects)

An array of objects representing the children of this object, if any.  Null if the object has no children.

  • index (read only – integer)

Returns the position (zero-based index) of this item’s parent’s array of children.

  • playNumber (read only – integer)

Always 0 for a Delay.

  • playNumberBeforeRenewal (read only – integer)

If this item repeats in parallel with the “Renew parallel repeats” option enabled, this is an integer value that is the “playNumber” value of the original parallel repeat for this item if it has been renewed because a prior parallel repeat ended. If this is the original parallel repeat, the value of playNumberBeforeRenewal will be equal to the value of playNumber. If this item does not repeat in parallel, the value will be zero.

For example, if parallel repeat number 5 of the item ends, but the Renew parallel repeats checkbox is enabled, the ending repeat will be replaced with a new, replacement repeat. The new repeat will have new repeatIndex and playNumber values (according to how many other repeats have already occurred). However, the playNumberBeforeRenewal value will still be 5 in this example.

This property is always 0 for Composition, Checkpoint, Delay, and Target.

  • repeatIndex (read only – integer)

Always -1 for a Target.

  • nextItem (read only – object)

Returns the next item after this one in this item’s parent’s array of children, or null if this is the last item.  In other words, returns the next sibling in the object hierarchy.  Equivalent to:
item.parent.children(item.index + 1)
where "item" is the current item.

  • previousItem (read only – object)

Returns the previous item before this one in this item’s parent’s array of children, or null of this is the first item.  In other words, returns the next sibling in the object hierarchy. .  Equivalent to:
item.parent.children(item.index - 1)
where "item" is the current item.

  • forEachValue (read only – string, number, date/time, or null)

This property is always null for Targets.

  • cookies (readable and settable – array of "structs" (objects with properties))

This contains the current list of cookies being maintained. This list changes as responses are received that contain cookies.

The value is null if there are currently no cookies being maintained.

There is a single list of cookies maintained across all Targets within the same instance of the same Clip.  Thus the value for this property will be the same for all Targets in the same instance of the same Clip, and setting this property affects the Clip’s cookie processing across all Targets within the Clip.

This property can be set to replace the entire list of cookies.  This can be done by modifying the existing list, or by creating an entirely new list.

The value of the property is an array of Objects.  Each object in the array has the following property values:

  • "name" (String) – the name of the cookie.
  • "domain" (String) – the domain name of the cookie.
  • "path" (String) – the cookie’s path.
  • "value" (String) – the value of the cookie.
  • "expirationDate" (Date object) – the expiration date of the cookie (null if none).
  • "secure" (Boolean) – true if it is a secure cookie.
 

Target Methods

getChild Method

Returns a specific child object by name, or null if there is no child with the specified name.


object getChild(string childName)

getItemViaPath Method

Given a type of item and the path to that item in the Composition object hierarchy, returns the object in the hierarchy that represents that item.


object getItemViaPath(string itemType, string path)

The "itemType" parameter value indicates the type of item (not case sensitive):

  • "Composition"
  • "Band"
  • "Track"
  • "Clip"
  • "Chain"
  • "Message"
  • "Browser Action"
  • "Delay"
  • "Checkpoint"
  • "Target"

The "path" parameter contains a path as specified for In Situ Substitution Specifications.  The path can be relative to the current item (for example to specify another item in the same Clip, the Band, Track and Clip portions of the path can be omitted).

 

string signURL(string url)

This method "signs" a URL according to the OAuth ("Open Authorization") protocol.

The "url" parameter is a complete HTTP URL. The return value is a modified version of the URL, "signed" according to OAuth.

The information needed to perform the signing operation is taken from the following System Property values of the Target:

  • "oauth_consumer_key"
  • "oauth_consumer_secret"
  • "oauth_token"
  • "oauth_token_secret"
  • "oauth_signature_method"

Attachments

    Outcomes