ElvClient/ContentAccess

Methods for accessing content types, libraries and objects

Source:

Methods

static AccessInfo({
objectId,
argsoptional
}) → Promise.<Object>

Retrieve info about the access charge and permissions for the specified object.

Note: Access charge is specified in ether

Returns: Info about the access charge and whether or not the object is accessible to the current user
Parameters:
Name Type Attributes Description
objectId string

ID of the object
args object <optional>

Arguments to the getAccessInfo method - See the base content contract
Example
async AccessInfo({
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


{
  "visibilityCode": 0,
  "visible": false,
  "accessible": false,
  "editable": false,
  "hasAccess": true,
  "accessCode": 0,
  "accessCharge": "0.5"
}
Source:

static AccessRequest({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
argsoptional,
updateoptional,
noCacheoptional
}) → Promise.<Object>

Make an explicit call to accessRequest or updateRequest of the appropriate contract. Unless noCache is specified on this method or on the client, the resultant transaction hash of this method will be cached for all subsequent access to this contract.

Note: Access and update requests are handled automatically by ElvClient. Use this method only if you need to make an explicit call. For example, if you need to specify custom arguments to access a content object, you can call this method explicitly with those arguments. Since the result is cached (by default), all subsequent calls to that content object will be authorized with that AccessRequest transaction.

Note: If the access request has an associated charge, this charge will be determined and supplied automatically.

Returns: Resultant AccessRequest or UpdateRequest event
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object
args Array <optional>
 [

Custom arguments to the accessRequest or updateRequest methods
update boolean <optional>
 false

If true, will call updateRequest instead of accessRequest
noCache boolean <optional>
 false

If true, the resultant transaction hash will not be cached for future use
Example
async AccessRequest({
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "args": [
    [],
    []
  ]
});


{
  "to": "0xa8f7CeE1cA8E77292f0CD7aad14849F783EE5Cba",
  "from": "0x665AEe2328fa4040e569e91be23Faf5A82a6186C",
  "contractAddress": null,
  "transactionIndex": 0,
  "gasUsed": {
    "_hex": "0x10dd9"
  },
  "logsBloom": "0x00000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000008000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000",
  "blockHash": "0x292d206ed39ef116e1d50d3e6913a0429391fee8108cf0e6042181f6a3898693",
  "transactionHash": "0x3ba9f70a72aa671bad6b41dcd568cefd4d5c55b6f4f7863e1128279b88487747",
  "logs": [
    {
      "transactionIndex": 0,
      "blockNumber": 203383,
      "transactionHash": "0x3ba9f70a72aa671bad6b41dcd568cefd4d5c55b6f4f7863e1128279b88487747",
      "address": "0xa8f7CeE1cA8E77292f0CD7aad14849F783EE5Cba",
      "topics": [
        "0x545ceffc5093a8300777a74bb094968fbd62d128313df01eb72fd5350ec659c7"
      ],
      "data": "0xde7e797f3ee454dc0637e4fa717ff114d1c58222c420acd970225a3d6b73cc8500000000000000000000000097172a5190a9967238444e2e7983f934a8d40e470000000000000000000000000000000000000000000000000000000000000000000000000000000000000000665aee2328fa4040e569e91be23faf5a82a6186c00000000000000000000000000000000000000000000000000000178189b1928",
      "logIndex": 0,
      "blockHash": "0x292d206ed39ef116e1d50d3e6913a0429391fee8108cf0e6042181f6a3898693",
      "transactionLogIndex": 0,
      "decode": "<function>",
      "name": "AccessRequestV3",
      "signature": "AccessRequestV3(uint256,address,bytes32,address,uint256)",
      "topic": "0x545ceffc5093a8300777a74bb094968fbd62d128313df01eb72fd5350ec659c7",
      "values": {
        "0": {
          "_hex": "0xde7e797f3ee454dc0637e4fa717ff114d1c58222c420acd970225a3d6b73cc85"
        },
        "1": "0x97172A5190A9967238444e2e7983f934A8D40e47",
        "2": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "3": "0x665AEe2328fa4040e569e91be23Faf5A82a6186C",
        "4": {
          "_hex": "0x0178189b1928"
        },
        "requestNonce": {
          "_hex": "0xde7e797f3ee454dc0637e4fa717ff114d1c58222c420acd970225a3d6b73cc85"
        },
        "parentAddress": "0x97172A5190A9967238444e2e7983f934A8D40e47",
        "contextHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "accessor": "0x665AEe2328fa4040e569e91be23Faf5A82a6186C",
        "requestTimestamp": {
          "_hex": "0x0178189b1928"
        },
        "length": 5
      }
    }
  ],
  "blockNumber": 203383,
  "confirmations": 1,
  "cumulativeGasUsed": {
    "_hex": "0x10dd9"
  },
  "status": 1,
  "byzantium": true
}
Source:

static AccessType({id}) → Promise.<string>

Return the type of contract backing the specified ID

Returns: Contract type of the item - "space", "library", "type", "object", "wallet", "group", or "other"
Parameters:
Name Type Description
id string

ID of the item
Examples
async AccessType({
  "id": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy"
});


"object"
async AccessType({
  "id": "iq__2zvCXt22xrdJXn3ctg3TbPLk18gC"
});


"wallet"
async AccessType({
  "id": "iq__3MvjYsa9bi4aywAYAXUhrvsQVHZq"
});


"object"
async AccessType({
  "id": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


"object"
Source:

static AssetMetadata({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
metadataoptional,
localization,
produceLinkUrlsoptional
}) → Promise.<Object>

Retrive public/asset_metadata from the specified object, performing automatic localization override based on the specified localization info.

File and rep links will have urls generated automatically within them (See the produceLinkUrls parameter in ContentObjectMetadata)

Returns: public/asset_metadata of the specified object, overwritten with specified localization
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Version of the object -- if not specified, latest version is used
metadata Object <optional>

If you have already retrieved metadata for the object and just want to perform localization, the metadata (Starting from public/asset_metadata) can be provided to avoid re-fetching the metadata.
localization Array

A list of locations of localized metadata, ordered from highest to lowest priority

 localization: [
   ["info_territories", "France", "FR"],
   ["info_locals", "FR"]
 ]
produceLinkUrls boolean <optional>
 false

If specified, file and rep links will automatically be populated with a full URL
Example
async AssetMetadata({
  "versionHash": "hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv",
  "localization": [
    [
      "info_territories",
      "France",
      "FR"
    ],
    [
      "info_locals",
      "FR"
    ]
  ]
});


{
  "asset_type": "primary",
  "display_title": "As Good As It Gets",
  "clips": {},
  "episodes": {},
  "ip_title_id": "2606",
  "playlists": {},
  "seasons": {},
  "series": {},
  "slug": "ASGDGT",
  "images": {
    "poster": {
      "default": {
        ".": {
          "auto_update": {
            "tag": "latest"
          },
          "container": "hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv"
        },
        "/": "./files/images/poster/ASGOODASITGETS_Packshots_800X1200_FrenchParisian.jpg",
        "url": "https://host-66-220-3-85.contentfabric.io/q/hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv/meta/public/asset_metadata/info_locals/FR/images/poster/default?resolve=true&authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSIsImFkZHIiOiIweDIwMDM3ZDRiZjkyYmI0YmZhMDQ3MTRiMWQ4ZDdlYmU2OGJmZWUxZWMiLCJ0eF9pZCI6IjB4OWFiYmJjYjJhNGU5MmM4YjBiMDE2M2Q3ZGU0YTljMzRhODY3MjYzMjAzZmNiMzQ0ODdkOWM4Y2FjZWUzZGZlMCIsInFsaWJfaWQiOiJpbGliMmRoMXl3YXpVUHo0Y2FHQ2tEaHRnR1J5enRUaSJ9.RVMyNTZLX0s1QU50bmRkVWZ1UEtodUNqZjlkZXlyNDJMM0pxVkpLajFSeWk2OFFLMmRtUVJjWEJXQlpBWE14N2JGdlBleEc5Tm84YVJZTUw3Q0hqaHp6UG1hZE1CQUI1"
      },
      "thumbnail": {
        ".": {
          "auto_update": {
            "tag": "latest"
          },
          "container": "hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv"
        },
        "/": "./rep/thumbnail/files/images/poster/ASGOODASITGETS_Packshots_800X1200_FrenchParisian.jpg",
        "url": "https://host-66-220-3-85.contentfabric.io/q/hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv/meta/public/asset_metadata/info_locals/FR/images/poster/thumbnail?resolve=true&authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSIsImFkZHIiOiIweDIwMDM3ZDRiZjkyYmI0YmZhMDQ3MTRiMWQ4ZDdlYmU2OGJmZWUxZWMiLCJ0eF9pZCI6IjB4OWFiYmJjYjJhNGU5MmM4YjBiMDE2M2Q3ZGU0YTljMzRhODY3MjYzMjAzZmNiMzQ0ODdkOWM4Y2FjZWUzZGZlMCIsInFsaWJfaWQiOiJpbGliMmRoMXl3YXpVUHo0Y2FHQ2tEaHRnR1J5enRUaSJ9.RVMyNTZLX0s1QU50bmRkVWZ1UEtodUNqZjlkZXlyNDJMM0pxVkpLajFSeWk2OFFLMmRtUVJjWEJXQlpBWE14N2JGdlBleEc5Tm84YVJZTUw3Q0hqaHp6UG1hZE1CQUI1"
      }
    }
  },
  "title": "Pour Le Pire Et Pour Le Meilleur",
  "title_type": "title",
  "titles": {},
  "sources": {
    "default": {
      ".": {
        "container": "hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv"
      },
      "/": "./rep/playout/default/options.json",
      "url": "https://host-66-220-3-85.contentfabric.io/q/hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv/meta/public/asset_metadata/sources/default?resolve=true&authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSIsImFkZHIiOiIweDIwMDM3ZDRiZjkyYmI0YmZhMDQ3MTRiMWQ4ZDdlYmU2OGJmZWUxZWMiLCJ0eF9pZCI6IjB4OWFiYmJjYjJhNGU5MmM4YjBiMDE2M2Q3ZGU0YTljMzRhODY3MjYzMjAzZmNiMzQ0ODdkOWM4Y2FjZWUzZGZlMCIsInFsaWJfaWQiOiJpbGliMmRoMXl3YXpVUHo0Y2FHQ2tEaHRnR1J5enRUaSJ9.RVMyNTZLX0s1QU50bmRkVWZ1UEtodUNqZjlkZXlyNDJMM0pxVkpLajFSeWk2OFFLMmRtUVJjWEJXQlpBWE14N2JGdlBleEc5Tm84YVJZTUw3Q0hqaHp6UG1hZE1CQUI1"
    }
  },
  "info": {
    "copyright": "© 1997 TriStar Pictures, Inc.  All Rights Reserved.",
    "country_of_origin": "U.S.A.[excluding Territories & Possessions]",
    "episode_number": "00000",
    "imdb_id": "tt0119822",
    "made_for_media": "Theatrical,2",
    "mpaa_rating": "PG-13",
    "mpaa_rating_reason": "Rated PG-13 on appeal for strong language, thematic elements, nudity and a beating.",
    "product_type": "feature",
    "genre": [
      "Comedie"
    ],
    "release_date": "1997-12-23",
    "runtime": "138",
    "sales_synopsis": "Reclus dans son appartement luxueux, Melvin Udall rédige à la chaîne des romans sentimentaux. Mais l'amour fait cruellement défaut à ce solitaire excentrique. Derrière son apparente méchanceté, il dissimule une peur panique du contact humain, une multitude de phobies et d'obsessions. Contraint d'héberger un chien dont le maître, son voisin Simon est hospitalisé, Melvin s'attache à l'animal et grâce à lui, finit par ressentir compassion et amitié pour son entourage notament pour Carol, la serveuse de son restaurant préféré...",
    "status": "Active",
    "synopsis": "Reclus dans son appartement luxueux, Melvin Udall rédige à la chaîne des romans sentimentaux. Mais l'amour fait cruellement défaut à ce solitaire excentrique. Derrière son apparente méchanceté, il dissimule une peur panique du contact humain, une multitude de phobies et d'obsessions. Contraint d'héberger un chien dont le maître, son voisin Simon est hospitalisé, Melvin s'attache à l'animal et grâce à lui, finit par ressentir compassion et amitié pour son entourage notament pour Carol, la serveuse de son restaurant préféré...",
    "us_release_date": "12/23/1997",
    "us_release_year": "1997",
    "info_locals": {
      "FR": {
        "title": "Pour Le Pire Et Pour Le Meilleur",
        "info": {
          "sales_synopsis": "Le monde dysfonctionnel d'un auteur est changé à jamais par une serveuse mère d'un enfant malade, par un voisin artiste et par un chien laid, mais affectueux.\n",
          "synopsis": "Reclus dans son appartement luxueux, Melvin Udall rédige à la chaîne des romans sentimentaux. Mais l'amour fait cruellement défaut à ce solitaire excentrique. Derrière son apparente méchanceté, il dissimule une peur panique du contact humain, une multitude de phobies et d'obsessions. Contraint d'héberger un chien dont le maître, son voisin Simon est hospitalisé, Melvin s'attache à l'animal et grâce à lui, finit par ressentir compassion et amitié pour son entourage notament pour Carol, la serveuse de son restaurant préféré...",
          "genre": [
            "Comedie",
            "Romance"
          ]
        },
        "images": {
          "poster": {
            "default": {
              ".": {
                "auto_update": {
                  "tag": "latest"
                },
                "container": "hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv"
              },
              "/": "./files/images/poster/ASGOODASITGETS_Packshots_800X1200_FrenchParisian.jpg",
              "url": "https://host-66-220-3-85.contentfabric.io/q/hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv/meta/public/asset_metadata/info_locals/FR/images/poster/default?resolve=true&authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSIsImFkZHIiOiIweDIwMDM3ZDRiZjkyYmI0YmZhMDQ3MTRiMWQ4ZDdlYmU2OGJmZWUxZWMiLCJ0eF9pZCI6IjB4OWFiYmJjYjJhNGU5MmM4YjBiMDE2M2Q3ZGU0YTljMzRhODY3MjYzMjAzZmNiMzQ0ODdkOWM4Y2FjZWUzZGZlMCIsInFsaWJfaWQiOiJpbGliMmRoMXl3YXpVUHo0Y2FHQ2tEaHRnR1J5enRUaSJ9.RVMyNTZLX0s1QU50bmRkVWZ1UEtodUNqZjlkZXlyNDJMM0pxVkpLajFSeWk2OFFLMmRtUVJjWEJXQlpBWE14N2JGdlBleEc5Tm84YVJZTUw3Q0hqaHp6UG1hZE1CQUI1"
            },
            "thumbnail": {
              ".": {
                "auto_update": {
                  "tag": "latest"
                },
                "container": "hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv"
              },
              "/": "./rep/thumbnail/files/images/poster/ASGOODASITGETS_Packshots_800X1200_FrenchParisian.jpg",
              "url": "https://host-66-220-3-85.contentfabric.io/q/hq__6NB89BEzuWPENmJiXL6Sj4eLnRXbsTxdfrEJBFZEguoQ2dEPGBYoSKhBAcatPBxWHxyCDJLFsv/meta/public/asset_metadata/info_locals/FR/images/poster/thumbnail?resolve=true&authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSIsImFkZHIiOiIweDIwMDM3ZDRiZjkyYmI0YmZhMDQ3MTRiMWQ4ZDdlYmU2OGJmZWUxZWMiLCJ0eF9pZCI6IjB4OWFiYmJjYjJhNGU5MmM4YjBiMDE2M2Q3ZGU0YTljMzRhODY3MjYzMjAzZmNiMzQ0ODdkOWM4Y2FjZWUzZGZlMCIsInFsaWJfaWQiOiJpbGliMmRoMXl3YXpVUHo0Y2FHQ2tEaHRnR1J5enRUaSJ9.RVMyNTZLX0s1QU50bmRkVWZ1UEtodUNqZjlkZXlyNDJMM0pxVkpLajFSeWk2OFFLMmRtUVJjWEJXQlpBWE14N2JGdlBleEc5Tm84YVJZTUw3Q0hqaHp6UG1hZE1CQUI1"
            }
          }
        }
      }
    },
    "info_territories": {
      "France": {
        "FR": {
          "images": {},
          "info": {
            "sales_synopsis": "Reclus dans son appartement luxueux, Melvin Udall rédige à la chaîne des romans sentimentaux. Mais l'amour fait cruellement défaut à ce solitaire excentrique. Derrière son apparente méchanceté, il dissimule une peur panique du contact humain, une multitude de phobies et d'obsessions. Contraint d'héberger un chien dont le maître, son voisin Simon est hospitalisé, Melvin s'attache à l'animal et grâce à lui, finit par ressentir compassion et amitié pour son entourage notament pour Carol, la serveuse de son restaurant préféré...",
            "genre": [
              "Comedie"
            ]
          }
        }
      }
    }
  }
}
Source:

static AuditContentObject({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
saltoptional,
samplesoptional,
authorizationTokenoptional
}) → Promise.<Object>

Audit the specified content object against several content fabric nodes

Returns: Response describing audit results
Parameters:
Name Type Attributes Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object -- if not specified, latest version is returned
salt string <optional>

base64-encoded byte sequence for salting the audit hash
samples Array.<number> <optional>

list of percentages (0.0 - <1.0) used for sampling the content part list, up to 3
authorizationToken string <optional>

Additional authorization token for this request
Source:

static AvailableDRMs() → Promise.<Array.<string>>

Determine available DRM types available in this browser environment.

Source:

static AvailableOfferings(
objectIdoptional,
versionHashoptional,
writeTokenoptional,
linkPathoptional,
signedLinkoptional,
directLinkoptional,
handleroptional,
authorizationTokenoptional
) → Promise.<Object>

Retrieve available playout offerings for the specified content

Returns: The available offerings
Parameters:
Name Type Attributes Default Description
objectId string <optional>

ID of the content
versionHash string <optional>

Version hash of the content
writeToken string <optional>

Write token for the content
linkPath string <optional>

If playing from a link, the path to the link
signedLink boolean <optional>

Specify if linkPath is referring to a signed link
directLink boolean <optional>

Specify if linkPath is pointing directly to the offerings endpoint
handler string <optional>
 playout

The handler to use for playout (not used with links)
authorizationToken Object <optional>

Additional authorization token for authorizing this request
Example
async AvailableOfferings({
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy"
});


{
  "default": {
    "display_name": "default"
  }
}
Source:

static BitmovinPlayoutOptions({
objectIdoptional,
versionHashoptional,
writeTokenoptional,
linkPathoptional,
signedLinkoptional,
protocols,
drms,
handleroptional,
offeringoptional,
playoutTypeoptional,
contextoptional,
authorizationTokenoptional,
optionsoptional
})

Retrieve playout options in BitMovin player format for the specified content that satisfy the given protocol and DRM requirements

If only objectId is specified, latest version will be played. To retrieve playout options for a specific version of the content, provide the versionHash parameter (in which case objectId is unnecessary)

Parameters:
Name Type Attributes Default Description
objectId string <optional>

ID of the content
versionHash string <optional>

Version hash of the content
writeToken string <optional>

Write token for the content
linkPath string <optional>

If playing from a link, the path to the link
signedLink boolean <optional>

Specify if linkPath is referring to a signed link
protocols Array.<string> ["dash","hls"]

Acceptable playout protocols ("dash", "hls")
drms Array.<string>

Acceptable DRM formats ("aes-128", "clear", "fairplay", "playready", "sample-aes", "widevine")
handler string <optional>
 playout

The handler to use for playout
offering string <optional>
 default

The offering to play
playoutType string <optional>

The type of playout
context Object <optional>

Additional audience data to include in the authorization request

  • Note: Context must be a map of string->string
authorizationToken Object <optional>

Additional authorization token for authorizing this request
options Object <optional>

Additional query parameters to pass when requesting available playout options, such as clipping parameters.
Examples
async BitmovinPlayoutOptions({
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy",
  "protocols": [
    "hls",
    "dash"
  ],
  "drms": []
});


{
  "drm": {},
  "dash": "https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV/q/hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3/rep/playout/default/dash-clear/dash.mpd?authorization=ascsj_8epgtRAWyTqiAFRx9ubkMgnk7ByFmEdpV7yvJFzUVAatMqikJtqEA1L2Z37ZycWmo2HtR4t6N32aNK15gSLffBjETtAbzFJFxvQKHQZgnipmhFtFC1JN5PBjwNMxNxV1TxiRfCmWXUZ9EH6ej417e6KmvNwS1haZuVZQWvFnRkYSdwqBCxb8v3dUCBYRsKTU6cgTpRYLncREqYkVqVM1XeqCRPZdW4XRYRzkSbq7qHPJnhajP2kBifu5qZAcED2LrnpWKgy5N6z8hc11CnopAt7FjHJwTTCqahf3jo28z5jmcZF1zsL6DhoLpCW9dvGbAzJJksY3FZJbS6uT5KeuGrAoUUKWT6pdxMEc5eJqrKTRnzQxiRBra4KDEqZU5RQaaQbc3HCbDrQFD5vbUE6CPKbX9jr1CYSPLd5mmgBgMUfwsZubF6LesQfujhHGVVbxCyG7uA1dPSxJFt3L756yeNWYjMqH6cDyX73Mv5ew84YHQr19kscfQ8qQw5tTpipBZB5e7KVFNeUhcVoFxw3EmcT7ePPBA11Yjhh7K64wc7d7wEQp7PeB5bQo4D2xSniWKK9dUFdvmQyjJJS2DTrcAHFSV1zkFUywG48CctFy67i9uLZzsuanPxJCuPaT19kkmrhD72JFyM8fJL4WfMchvgry78N9PqFkaCBNoeRey2pAJUKTZ2QHoyQZSvNqAD7N9sAjg6dRJ5paxPduth8awaHQQWk69tTCPGAbcxS7Yqh13PX6y9mpscbf5khWi9KU2PwK8ajGornmHjxEekEJrfkKsTmRYx9vZMPtMSmQ828NButXMmQ8C.RVMyNTZLXzJTdjQ3S3dEVFlFU0VLWFZkZGp2VnNzOXZZMUVnbmZvTmduVXJ0YUZQckZIMUNiVDFiS1Mza1BCNHhIYW1XSmdkWXg2aldoNEU2cGhDUDh1OU1SdDZKMm1o&resolve=true",
  "hls": "https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV/q/hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3/rep/playout/default/hls-clear/playlist.m3u8?authorization=ascsj_8epgtRAWyTqiAFRx9ubkMgnk7ByFmEdpV7yvJFzUVAatMqikJtqEA1L2Z37ZycWmo2HtR4t6N32aNK15gSLffBjETtAbzFJFxvQKHQZgnipmhFtFC1JN5PBjwNMxNxV1TxiRfCmWXUZ9EH6ej417e6KmvNwS1haZuVZQWvFnRkYSdwqBCxb8v3dUCBYRsKTU6cgTpRYLncREqYkVqVM1XeqCRPZdW4XRYRzkSbq7qHPJnhajP2kBifu5qZAcED2LrnpWKgy5N6z8hc11CnopAt7FjHJwTTCqahf3jo28z5jmcZF1zsL6DhoLpCW9dvGbAzJJksY3FZJbS6uT5KeuGrAoUUKWT6pdxMEc5eJqrKTRnzQxiRBra4KDEqZU5RQaaQbc3HCbDrQFD5vbUE6CPKbX9jr1CYSPLd5mmgBgMUfwsZubF6LesQfujhHGVVbxCyG7uA1dPSxJFt3L756yeNWYjMqH6cDyX73Mv5ew84YHQr19kscfQ8qQw5tTpipBZB5e7KVFNeUhcVoFxw3EmcT7ePPBA11Yjhh7K64wc7d7wEQp7PeB5bQo4D2xSniWKK9dUFdvmQyjJJS2DTrcAHFSV1zkFUywG48CctFy67i9uLZzsuanPxJCuPaT19kkmrhD72JFyM8fJL4WfMchvgry78N9PqFkaCBNoeRey2pAJUKTZ2QHoyQZSvNqAD7N9sAjg6dRJ5paxPduth8awaHQQWk69tTCPGAbcxS7Yqh13PX6y9mpscbf5khWi9KU2PwK8ajGornmHjxEekEJrfkKsTmRYx9vZMPtMSmQ828NButXMmQ8C.RVMyNTZLXzJTdjQ3S3dEVFlFU0VLWFZkZGp2VnNzOXZZMUVnbmZvTmduVXJ0YUZQckZIMUNiVDFiS1Mza1BCNHhIYW1XSmdkWXg2aldoNEU2cGhDUDh1OU1SdDZKMm1o&resolve=true"
}
async BitmovinPlayoutOptions({
  "versionHash": "hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs",
  "linkPath": "public/videoLink/default",
  "protocols": [
    "hls",
    "dash"
  ],
  "drms": []
});


{
  "drm": {},
  "dash": "https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV/q/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout/default/dash-clear/dash.mpd?authorization=ascsj_8epgtRAWyTqiAFRx9ubkMgnk7ByFmEdpV7yvJFzUVAatMqikJtqEA1L2Z37ZycWmo2HtR4t6N32aNK15gSLffBjETtAbzFJFxvQKHQZgnipmhFtFC1JN5PBjwNMxNxV1TxiRfCmWXUZ9EH6ej417e6KmvNwS1haZuVZQWvFnRkYSdwqBCxb8v3dUCBYRsKTU6cgTpRYLncREqYkVqVM1XeqCRPZdW4XRYRzkSbq7qHPJnhajP2kBifu5qZAcED2LrnpWKgy5N6z8hc11CnopAt7FjHJwTTCqahf3jo28z5jmcZF1zsL6DhoLpCW9dvGbAzJJksY3FZJbS6uT5KeuGrAoUUKWT6pdxMEc5eJqrKTRnzQxiRBra4KDEqZU5RQaaQbc3HCbDrQFD5vbUE6CPKbX9jr1CYSPLd5mmgBgMUfwsZubF6LesQfujhHGVVbxCyG7uA1dPSxJFt3L756yeNWYjMqH6cDyX73Mv5ew84YHQr19kscfQ8qQw5tTpipBZB5e7KVFNeUhcVoFxw3EmcT7ePPBA11Yjhh7K64wc7d7wEQp7PeB5bQo4D2xSniWKK9dUFdvmQyjJJS2DTrcAHFSV1zkFUywG48CctFy67i9uLZzsuanPxJCuPaT19kkmrhD72JFyM8fJL4WfMchvgry78N9PqFkaCBNoeRey2pAJUKTZ2QHoyQZSvNqAD7N9sAjg6dRJ5paxPduth8awaHQQWk69tTCPGAbcxS7Yqh13PX6y9mpscbf5khWi9KU2PwK8ajGornmHjxEekEJrfkKsTmRYx9vZMPtMSmQ828NButXMmQ8C.RVMyNTZLXzJTdjQ3S3dEVFlFU0VLWFZkZGp2VnNzOXZZMUVnbmZvTmduVXJ0YUZQckZIMUNiVDFiS1Mza1BCNHhIYW1XSmdkWXg2aldoNEU2cGhDUDh1OU1SdDZKMm1o&resolve=true",
  "hls": "https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV/q/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout/default/hls-clear/playlist.m3u8?authorization=ascsj_8epgtRAWyTqiAFRx9ubkMgnk7ByFmEdpV7yvJFzUVAatMqikJtqEA1L2Z37ZycWmo2HtR4t6N32aNK15gSLffBjETtAbzFJFxvQKHQZgnipmhFtFC1JN5PBjwNMxNxV1TxiRfCmWXUZ9EH6ej417e6KmvNwS1haZuVZQWvFnRkYSdwqBCxb8v3dUCBYRsKTU6cgTpRYLncREqYkVqVM1XeqCRPZdW4XRYRzkSbq7qHPJnhajP2kBifu5qZAcED2LrnpWKgy5N6z8hc11CnopAt7FjHJwTTCqahf3jo28z5jmcZF1zsL6DhoLpCW9dvGbAzJJksY3FZJbS6uT5KeuGrAoUUKWT6pdxMEc5eJqrKTRnzQxiRBra4KDEqZU5RQaaQbc3HCbDrQFD5vbUE6CPKbX9jr1CYSPLd5mmgBgMUfwsZubF6LesQfujhHGVVbxCyG7uA1dPSxJFt3L756yeNWYjMqH6cDyX73Mv5ew84YHQr19kscfQ8qQw5tTpipBZB5e7KVFNeUhcVoFxw3EmcT7ePPBA11Yjhh7K64wc7d7wEQp7PeB5bQo4D2xSniWKK9dUFdvmQyjJJS2DTrcAHFSV1zkFUywG48CctFy67i9uLZzsuanPxJCuPaT19kkmrhD72JFyM8fJL4WfMchvgry78N9PqFkaCBNoeRey2pAJUKTZ2QHoyQZSvNqAD7N9sAjg6dRJ5paxPduth8awaHQQWk69tTCPGAbcxS7Yqh13PX6y9mpscbf5khWi9KU2PwK8ajGornmHjxEekEJrfkKsTmRYx9vZMPtMSmQ828NButXMmQ8C.RVMyNTZLXzJTdjQ3S3dEVFlFU0VLWFZkZGp2VnNzOXZZMUVnbmZvTmduVXJ0YUZQckZIMUNiVDFiS1Mza1BCNHhIYW1XSmdkWXg2aldoNEU2cGhDUDh1OU1SdDZKMm1o&resolve=true"
}
async BitmovinPlayoutOptions({
  "objectId": "iq__3MvjYsa9bi4aywAYAXUhrvsQVHZq",
  "linkPath": "public/videoLink",
  "protocols": [
    "hls",
    "dash"
  ],
  "drms": []
});


{
  "drm": {},
  "dash": "https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV/q/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout/default/dash-clear/dash.mpd?authorization=ascsj_8epgtRAWyTqiAFRx9ubkMgnk7ByFmEdpV7yvJFzUVAatMqikJtqEA1L2Z37ZycWmo2HtR4t6N32aNK15gSLffBjETtAbzFJFxvQKHQZgnipmhFtFC1JN5PBjwNMxNxV1TxiRfCmWXUZ9EH6ej417e6KmvNwS1haZuVZQWvFnRkYSdwqBCxb8v3dUCBYRsKTU6cgTpRYLncREqYkVqVM1XeqCRPZdW4XRYRzkSbq7qHPJnhajP2kBifu5qZAcED2LrnpWKgy5N6z8hc11CnopAt7FjHJwTTCqahf3jo28z5jmcZF1zsL6DhoLpCW9dvGbAzJJksY3FZJbS6uT5KeuGrAoUUKWT6pdxMEc5eJqrKTRnzQxiRBra4KDEqZU5RQaaQbc3HCbDrQFD5vbUE6CPKbX9jr1CYSPLd5mmgBgMUfwsZubF6LesQfujhHGVVbxCyG7uA1dPSxJFt3L756yeNWYjMqH6cDyX73Mv5ew84YHQr19kscfQ8qQw5tTpipBZB5e7KVFNeUhcVoFxw3EmcT7ePPBA11Yjhh7K64wc7d7wEQp7PeB5bQo4D2xSniWKK9dUFdvmQyjJJS2DTrcAHFSV1zkFUywG48CctFy67i9uLZzsuanPxJCuPaT19kkmrhD72JFyM8fJL4WfMchvgry78N9PqFkaCBNoeRey2pAJUKTZ2QHoyQZSvNqAD7N9sAjg6dRJ5paxPduth8awaHQQWk69tTCPGAbcxS7Yqh13PX6y9mpscbf5khWi9KU2PwK8ajGornmHjxEekEJrfkKsTmRYx9vZMPtMSmQ828NButXMmQ8C.RVMyNTZLXzJTdjQ3S3dEVFlFU0VLWFZkZGp2VnNzOXZZMUVnbmZvTmduVXJ0YUZQckZIMUNiVDFiS1Mza1BCNHhIYW1XSmdkWXg2aldoNEU2cGhDUDh1OU1SdDZKMm1o&resolve=true",
  "hls": "https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV/q/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout/default/hls-clear/playlist.m3u8?authorization=ascsj_8epgtRAWyTqiAFRx9ubkMgnk7ByFmEdpV7yvJFzUVAatMqikJtqEA1L2Z37ZycWmo2HtR4t6N32aNK15gSLffBjETtAbzFJFxvQKHQZgnipmhFtFC1JN5PBjwNMxNxV1TxiRfCmWXUZ9EH6ej417e6KmvNwS1haZuVZQWvFnRkYSdwqBCxb8v3dUCBYRsKTU6cgTpRYLncREqYkVqVM1XeqCRPZdW4XRYRzkSbq7qHPJnhajP2kBifu5qZAcED2LrnpWKgy5N6z8hc11CnopAt7FjHJwTTCqahf3jo28z5jmcZF1zsL6DhoLpCW9dvGbAzJJksY3FZJbS6uT5KeuGrAoUUKWT6pdxMEc5eJqrKTRnzQxiRBra4KDEqZU5RQaaQbc3HCbDrQFD5vbUE6CPKbX9jr1CYSPLd5mmgBgMUfwsZubF6LesQfujhHGVVbxCyG7uA1dPSxJFt3L756yeNWYjMqH6cDyX73Mv5ew84YHQr19kscfQ8qQw5tTpipBZB5e7KVFNeUhcVoFxw3EmcT7ePPBA11Yjhh7K64wc7d7wEQp7PeB5bQo4D2xSniWKK9dUFdvmQyjJJS2DTrcAHFSV1zkFUywG48CctFy67i9uLZzsuanPxJCuPaT19kkmrhD72JFyM8fJL4WfMchvgry78N9PqFkaCBNoeRey2pAJUKTZ2QHoyQZSvNqAD7N9sAjg6dRJ5paxPduth8awaHQQWk69tTCPGAbcxS7Yqh13PX6y9mpscbf5khWi9KU2PwK8ajGornmHjxEekEJrfkKsTmRYx9vZMPtMSmQ828NButXMmQ8C.RVMyNTZLXzJTdjQ3S3dEVFlFU0VLWFZkZGp2VnNzOXZZMUVnbmZvTmduVXJ0YUZQckZIMUNiVDFiS1Mza1BCNHhIYW1XSmdkWXg2aldoNEU2cGhDUDh1OU1SdDZKMm1o&resolve=true"
}
async BitmovinPlayoutOptions({
  "objectId": "iq__3MvjYsa9bi4aywAYAXUhrvsQVHZq",
  "linkPath": "public/multiOfferingVideoLink",
  "protocols": [
    "hls",
    "dash"
  ],
  "drms": []
});


{
  "drm": {},
  "dash": "https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV/q/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout/default/dash-clear/dash.mpd?authorization=ascsj_8epgtRAWyTqiAFRx9ubkMgnk7ByFmEdpV7yvJFzUVAatMqikJtqEA1L2Z37ZycWmo2HtR4t6N32aNK15gSLffBjETtAbzFJFxvQKHQZgnipmhFtFC1JN5PBjwNMxNxV1TxiRfCmWXUZ9EH6ej417e6KmvNwS1haZuVZQWvFnRkYSdwqBCxb8v3dUCBYRsKTU6cgTpRYLncREqYkVqVM1XeqCRPZdW4XRYRzkSbq7qHPJnhajP2kBifu5qZAcED2LrnpWKgy5N6z8hc11CnopAt7FjHJwTTCqahf3jo28z5jmcZF1zsL6DhoLpCW9dvGbAzJJksY3FZJbS6uT5KeuGrAoUUKWT6pdxMEc5eJqrKTRnzQxiRBra4KDEqZU5RQaaQbc3HCbDrQFD5vbUE6CPKbX9jr1CYSPLd5mmgBgMUfwsZubF6LesQfujhHGVVbxCyG7uA1dPSxJFt3L756yeNWYjMqH6cDyX73Mv5ew84YHQr19kscfQ8qQw5tTpipBZB5e7KVFNeUhcVoFxw3EmcT7ePPBA11Yjhh7K64wc7d7wEQp7PeB5bQo4D2xSniWKK9dUFdvmQyjJJS2DTrcAHFSV1zkFUywG48CctFy67i9uLZzsuanPxJCuPaT19kkmrhD72JFyM8fJL4WfMchvgry78N9PqFkaCBNoeRey2pAJUKTZ2QHoyQZSvNqAD7N9sAjg6dRJ5paxPduth8awaHQQWk69tTCPGAbcxS7Yqh13PX6y9mpscbf5khWi9KU2PwK8ajGornmHjxEekEJrfkKsTmRYx9vZMPtMSmQ828NButXMmQ8C.RVMyNTZLXzJTdjQ3S3dEVFlFU0VLWFZkZGp2VnNzOXZZMUVnbmZvTmduVXJ0YUZQckZIMUNiVDFiS1Mza1BCNHhIYW1XSmdkWXg2aldoNEU2cGhDUDh1OU1SdDZKMm1o&resolve=true",
  "hls": "https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV/q/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout/default/hls-clear/playlist.m3u8?authorization=ascsj_8epgtRAWyTqiAFRx9ubkMgnk7ByFmEdpV7yvJFzUVAatMqikJtqEA1L2Z37ZycWmo2HtR4t6N32aNK15gSLffBjETtAbzFJFxvQKHQZgnipmhFtFC1JN5PBjwNMxNxV1TxiRfCmWXUZ9EH6ej417e6KmvNwS1haZuVZQWvFnRkYSdwqBCxb8v3dUCBYRsKTU6cgTpRYLncREqYkVqVM1XeqCRPZdW4XRYRzkSbq7qHPJnhajP2kBifu5qZAcED2LrnpWKgy5N6z8hc11CnopAt7FjHJwTTCqahf3jo28z5jmcZF1zsL6DhoLpCW9dvGbAzJJksY3FZJbS6uT5KeuGrAoUUKWT6pdxMEc5eJqrKTRnzQxiRBra4KDEqZU5RQaaQbc3HCbDrQFD5vbUE6CPKbX9jr1CYSPLd5mmgBgMUfwsZubF6LesQfujhHGVVbxCyG7uA1dPSxJFt3L756yeNWYjMqH6cDyX73Mv5ew84YHQr19kscfQ8qQw5tTpipBZB5e7KVFNeUhcVoFxw3EmcT7ePPBA11Yjhh7K64wc7d7wEQp7PeB5bQo4D2xSniWKK9dUFdvmQyjJJS2DTrcAHFSV1zkFUywG48CctFy67i9uLZzsuanPxJCuPaT19kkmrhD72JFyM8fJL4WfMchvgry78N9PqFkaCBNoeRey2pAJUKTZ2QHoyQZSvNqAD7N9sAjg6dRJ5paxPduth8awaHQQWk69tTCPGAbcxS7Yqh13PX6y9mpscbf5khWi9KU2PwK8ajGornmHjxEekEJrfkKsTmRYx9vZMPtMSmQ828NButXMmQ8C.RVMyNTZLXzJTdjQ3S3dEVFlFU0VLWFZkZGp2VnNzOXZZMUVnbmZvTmduVXJ0YUZQckZIMUNiVDFiS1Mza1BCNHhIYW1XSmdkWXg2aldoNEU2cGhDUDh1OU1SdDZKMm1o&resolve=true"
}
Source:

static CallBitcodeMethod({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional,
method,
queryParamsoptional,
bodyoptional,
headersoptional,
constantoptional,
formatoptional
}) → Promise.<format>

Call the specified bitcode method on the specified object

Returns: The response from the call in the specified format
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Hash of the object version - if not specified, latest version will be used
writeToken string <optional>

Write token of an object draft - if calling bitcode of a draft object
method string

Bitcode method to call
queryParams Object <optional>

Query parameters to include in the request
body Object <optional>

Request body to include, if calling a non-constant method
headers Object <optional>

Request headers to include
constant boolean <optional>
 true

If specified, a GET request authenticated with an AccessRequest will be made. Otherwise, a POST with an UpdateRequest will be performed
format string <optional>
 json

The format of the response
Examples
async CallBitcodeMethod({
  "libraryId": "ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV",
  "objectId": "iq__fQhR2f757MCYQ7SNrwKh39XeSPs",
  "writeToken": "tqw__HSRoazbriLdH7CGobx96kWaZqkqo2Z1x9Qru5h5n1FyhfX9W6FkWjBH3EikHKUoFLLq3Jf5ZLbTL2UJjFwA",
  "method": "media/production_master/init",
  "body": {
    "access": []
  },
  "constant": false
});


{
  "logs": [
    "2021-03-09 20:06:22 Debug: avtest.initProdMaster()",
    "2021-03-09 20:06:22 Info: Get list of files from object",
    "2021-03-09 20:06:22 Info: 2 item(s) found in file list.",
    "2021-03-09 20:06:22 Info: Skipping '.'",
    "2021-03-09 20:06:22 Info: Analyzing Video.mp4",
    "2021-03-09 20:06:22 Debug: getAvpReqCtx filePath=Video.mp4 qhot=tqw__HSRoazbriLdH7CGobx96kWaZqkqo2Z1x9Qru5h5n1FyhfX9W6FkWjBH3EikHKUoFLLq3Jf5ZLbTL2UJjFwA key=tqw__HSRoazbriLdH7CGobx96kWaZqkqo2Z1x9Qru5h5n1FyhfX9W6FkWjBH3EikHKUoFLLq3Jf5ZLbTL2UJjFwA.txAll.Video.mp4",
    "2021-03-09 20:06:22 Info: Successfully generated default variant"
  ]
}
async CallBitcodeMethod({
  "libraryId": "ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV",
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy",
  "writeToken": "tqw__HSa7sjaqEvcqqzVzWXbKs3HYMrm2BiBqWMj228bGixxYn4ibq12Gr65QowfgLH9gYQEBDzxECpugP8g7Mp2",
  "method": "media/abr_mezzanine/init",
  "headers": {
    "Authorization": "Bearer eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4NjM2MTQyMTZhNGE1Zjg1YjNiYThlODAyMmRjODdmYjE4ZTJmYTExOTcxZDQ5NTc1YjQ1ZDdmNjNmOTMxZGYzZSIsInFsaWJfaWQiOiJpbGliM0pnWkJOeFpFOFprTTRqUDhZVUFkVG5qdWtXViJ9.RVMyNTZLX0NvczFEbmpHemZDWWhxbVE3cHYzZURRdm5ZMWZXbzJIQUZCODJHcjVjaERnWGZzSEEzMUhWQng0dVZ1QjVEOWZzWG9lZEd0aTJEcU5LclVuekhETWs2Q2pN,Bearer eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4NWU3NjBmNDAzZjhjOWVlMTNhNTZiYzI4M2Q4MzkyN2U2Yjk0MWZmY2NiYTY1MWJlYWFmNzZlMTM4NDU2ODFlYyIsInFsaWJfaWQiOiJpbGliM0pnWkJOeFpFOFprTTRqUDhZVUFkVG5qdWtXViJ9.RVMyNTZLX0YxUG51eUtxNHl5dnVXWTRXY0JDTmEyWVVLU0xhNGszMVo5Rkw2OE1lNENRcHFnam1MdTZnNWR5YXFRMXNtWm56bVlzczlrZ25EOVBmanZSU2N1TE5Bc0VC,Bearer eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4MGU5NjIwMGM2Y2UyNmM4ODY3YWI1Mzg1YmU5MmZkNTFlZTY1ZWZjNTFkMzA0NjVjMzI0YzM3Y2U0ZGJjZmFmZiJ9.RVMyNTZLXzI2SExZSm9Md2Y3dGprcVd2ejZCanhZN0dzWHRXVFNlS29zNGdLVHB5RHJka1h4UEFXQXphN05CM1NiMlZSQ1R3VVF0NHhKR0xvcjI5V2RUWGFqaDFiVTlw"
  },
  "body": {
    "offering_key": "default",
    "variant_key": "default",
    "prod_master_hash": "hq__sknpjER8hAHks8JkJKujw1JwDHPRXodMX59FiHS6ZLxPPSQmD1tE6bpvRyTNxiez5x1LCQmEH"
  },
  "constant": false
});


{
  "logs": [
    "2021-03-09 20:06:31 Debug: apiAbrMezzanineInit()",
    "2021-03-09 20:06:31 Info: Get abr.Profile from lib",
    "2021-03-09 20:06:31 Info: Get abr.Profile from lib metadata /abr_profile",
    "2021-03-09 20:06:31 Info: Get production.Master",
    "2021-03-09 20:06:31 Debug: getProductionVariantCtx(hq__sknpjER8hAHks8JkJKujw1JwDHPRXodMX59FiHS6ZLxPPSQmD1tE6bpvRyTNxiez5x1LCQmEH,default)",
    "2021-03-09 20:06:31 Debug: getting production.Master: hq__sknpjER8hAHks8JkJKujw1JwDHPRXodMX59FiHS6ZLxPPSQmD1tE6bpvRyTNxiez5x1LCQmEH",
    "2021-03-09 20:06:31 Debug: Get production.Variant 'default' from production.Master",
    "2021-03-09 20:06:31 Info: Generate abr.Offering",
    "2021-03-09 20:06:31 Info: Saving metadata"
  ]
}
async CallBitcodeMethod({
  "libraryId": "ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV",
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy",
  "writeToken": "tqw__HSa7sjaqEvcqqzVzWXbKs3HYMrm2BiBqWMj228bGixxYn4ibq12Gr65QowfgLNBUX6qWhcPxkCyMnoAaHpW",
  "headers": {
    "Authorization": "Bearer eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4NjM2MTQyMTZhNGE1Zjg1YjNiYThlODAyMmRjODdmYjE4ZTJmYTExOTcxZDQ5NTc1YjQ1ZDdmNjNmOTMxZGYzZSIsInFsaWJfaWQiOiJpbGliM0pnWkJOeFpFOFprTTRqUDhZVUFkVG5qdWtXViJ9.RVMyNTZLX0NvczFEbmpHemZDWWhxbVE3cHYzZURRdm5ZMWZXbzJIQUZCODJHcjVjaERnWGZzSEEzMUhWQng0dVZ1QjVEOWZzWG9lZEd0aTJEcU5LclVuekhETWs2Q2pN,Bearer eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4MGU5NjIwMGM2Y2UyNmM4ODY3YWI1Mzg1YmU5MmZkNTFlZTY1ZWZjNTFkMzA0NjVjMzI0YzM3Y2U0ZGJjZmFmZiJ9.RVMyNTZLXzI2SExZSm9Md2Y3dGprcVd2ejZCanhZN0dzWHRXVFNlS29zNGdLVHB5RHJka1h4UEFXQXphN05CM1NiMlZSQ1R3VVF0NHhKR0xvcjI5V2RUWGFqaDFiVTlw"
  },
  "method": "media/abr_mezzanine/prep_start",
  "constant": false,
  "body": {
    "access": [],
    "offering_key": "default",
    "job_indexes": null
  }
});


{
  "data": [
    "c056f89b-53f3-4aac-8b83-bd996cd37baf",
    "9ea07c9c-6f8a-41a0-b721-8fd7d72d82c8"
  ],
  "logs": [
    "2021-03-09 20:06:39 Debug: getAvpReqCtx filePath=Video.mp4 qhot=hq__sknpjER8hAHks8JkJKujw1JwDHPRXodMX59FiHS6ZLxPPSQmD1tE6bpvRyTNxiez5x1LCQmEH key=hq__sknpjER8hAHks8JkJKujw1JwDHPRXodMX59FiHS6ZLxPPSQmD1tE6bpvRyTNxiez5x1LCQmEH.txAudio.Video.mp4",
    "2021-03-09 20:06:39 Debug: getAvpReqCtx filePath=Video.mp4 qhot=hq__sknpjER8hAHks8JkJKujw1JwDHPRXodMX59FiHS6ZLxPPSQmD1tE6bpvRyTNxiez5x1LCQmEH key=hq__sknpjER8hAHks8JkJKujw1JwDHPRXodMX59FiHS6ZLxPPSQmD1tE6bpvRyTNxiez5x1LCQmEH.txVideo.Video.mp4"
  ]
}
async CallBitcodeMethod({
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy",
  "libraryId": "ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV",
  "writeToken": "tqw__HSa7sjaqEvcqqzVzWXbKs3HYMrm2BiBqWMj228bGixxYn4ibq12Gr65QowfgLNBUX6qWhcPxkCyMnoAaHpW",
  "method": "media/abr_mezzanine/offerings/default/finalize",
  "headers": {
    "Authorization": "Bearer eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4NjM2MTQyMTZhNGE1Zjg1YjNiYThlODAyMmRjODdmYjE4ZTJmYTExOTcxZDQ5NTc1YjQ1ZDdmNjNmOTMxZGYzZSIsInFsaWJfaWQiOiJpbGliM0pnWkJOeFpFOFprTTRqUDhZVUFkVG5qdWtXViJ9.RVMyNTZLX0NvczFEbmpHemZDWWhxbVE3cHYzZURRdm5ZMWZXbzJIQUZCODJHcjVjaERnWGZzSEEzMUhWQng0dVZ1QjVEOWZzWG9lZEd0aTJEcU5LclVuekhETWs2Q2pN,Bearer eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4MGU5NjIwMGM2Y2UyNmM4ODY3YWI1Mzg1YmU5MmZkNTFlZTY1ZWZjNTFkMzA0NjVjMzI0YzM3Y2U0ZGJjZmFmZiJ9.RVMyNTZLXzI2SExZSm9Md2Y3dGprcVd2ejZCanhZN0dzWHRXVFNlS29zNGdLVHB5RHJka1h4UEFXQXphN05CM1NiMlZSQ1R3VVF0NHhKR0xvcjI5V2RUWGFqaDFiVTlw"
  },
  "constant": false
});


{
  "logs": [
    "2021-03-09 20:07:22 Debug: getProductionVariantCtx(hq__sknpjER8hAHks8JkJKujw1JwDHPRXodMX59FiHS6ZLxPPSQmD1tE6bpvRyTNxiez5x1LCQmEH,default)",
    "2021-03-09 20:07:22 Debug: getting production.Master: hq__sknpjER8hAHks8JkJKujw1JwDHPRXodMX59FiHS6ZLxPPSQmD1tE6bpvRyTNxiez5x1LCQmEH",
    "2021-03-09 20:07:22 Debug: Get production.Variant 'default' from production.Master"
  ]
}
Source:

static Collection({collectionType}) → Promise.<Array.<string>>

Get a list of unique addresses of all of the specified type the current user has access to through both their user wallet and through access groups

Returns: List of addresses of available items
Parameters:
Name Type Description
collectionType string

Type of collection to retrieve

  • accessGroups
  • contentObjects
  • contentTypes
  • contracts
  • libraries
Examples
async Collection({
  "collectionType": "contentTypes"
});


[]
async Collection({
  "collectionType": "contentTypes"
});


[
  "0xB7f51115B2803082687B215F70049803034cdC81"
]
async Collection({
  "collectionType": "libraries"
});


[
  "0x97172A5190A9967238444e2e7983f934A8D40e47",
  "0x0414E14DF62371499B87C2cC0e6213b2f41bD9Ab"
]
async Collection({
  "collectionType": "accessGroups"
});


[
  "0x1770921fADA087576272cCCA2A30CC0F5Bbec934"
]
async Collection({
  "collectionType": "accessGroups"
});


[
  "0x1770921fADA087576272cCCA2A30CC0F5Bbec934",
  "0x7c9a679072F7320b5382577885e95a1cBF9bd0DD"
]
Source:

static ContentLibraries() → Promise.<Array.<string>>

List content libraries - returns a list of content library IDs available to the current user

Example
async ContentLibraries();


[
  "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "ilib4JHfGGkxT2rJvnEKeXV8LQWNSGA"
]
Source:

static ContentLibrary({libraryId}) → Promise.<Object>

Returns information about the content library

Parameters:
Name Type Description
libraryId string
Example
async ContentLibrary({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
});


{
  "id": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "qid": "iq__3762veoskHQtAwoUZZRX26V2qKc2",
  "meta": {}
}
Source:

static ContentLibraryOwner({libraryId}) → Promise.<string>

Returns the address of the owner of the specified content library

Returns: The account address of the owner
Parameters:
Name Type Description
libraryId string
Example
async ContentLibraryOwner({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
});


"0x665aee2328fa4040e569e91be23faf5a82a6186c"
Source:

static ContentObject({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional
}) → Promise.<Object>

Get a specific content object in the library

Returns: Description of content object
Parameters:
Name Type Attributes Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object -- if not specified, latest version is returned
writeToken string <optional>

Write token for an object draft -- if supplied, versionHash will be ignored
Examples
async ContentObject({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


{
  "id": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "hash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "type": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
  "qlib_id": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
}
async ContentObject({
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF"
});


{
  "id": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "hash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "type": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
  "qlib_id": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
}
async ContentObject({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF"
});


{
  "id": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "hash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "type": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
  "qlib_id": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
}
Source:

static ContentObjectAccessComplete({
objectId,
score
}) → Promise.<Object>

Call accessComplete on the specified content object contract using a previously cached requestID. Caching must be enabled and an access request must have been previously made on the specified object by this client instance.

Returns: Transaction log of the AccessComplete event
Parameters:
Name Type Description
objectId string

ID of the object
score number

Percentage score (0-100)
Example
async ContentObjectAccessComplete({
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "score": 90
});


{
  "to": "0xa8f7CeE1cA8E77292f0CD7aad14849F783EE5Cba",
  "from": "0x665AEe2328fa4040e569e91be23Faf5A82a6186C",
  "contractAddress": null,
  "transactionIndex": 0,
  "gasUsed": {
    "_hex": "0x9e18"
  },
  "logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000100000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000080000000002000000000000000000000000000000000000000000000000000",
  "blockHash": "0x1a1024c7b441c5b035219ac48438a8c2d72be1936650ad859e41dfb50717fbc4",
  "transactionHash": "0x4ae34daee7f96a31ba4d12567b6ef0fc3a1171b598aa10b5b18fc378bde1e516",
  "logs": [
    {
      "transactionIndex": 0,
      "blockNumber": 203384,
      "transactionHash": "0x4ae34daee7f96a31ba4d12567b6ef0fc3a1171b598aa10b5b18fc378bde1e516",
      "address": "0xa8f7CeE1cA8E77292f0CD7aad14849F783EE5Cba",
      "topics": [
        "0xd3e5b1d14681444d8159fa85b57104b685f47fb9164fd82b7fafe4e123dcc3a1"
      ],
      "data": "0xde7e797f3ee454dc0637e4fa717ff114d1c58222c420acd970225a3d6b73cc85000000000000000000000000000000000000000000000000000000000000000100000000000000000000000097172a5190a9967238444e2e7983f934a8d40e470000000000000000000000000000000000000000000000000000000000000000000000000000000000000000665aee2328fa4040e569e91be23faf5a82a6186c00000000000000000000000000000000000000000000000000000178189b1d10",
      "logIndex": 0,
      "blockHash": "0x1a1024c7b441c5b035219ac48438a8c2d72be1936650ad859e41dfb50717fbc4",
      "transactionLogIndex": 0,
      "decode": "<function>",
      "name": "AccessCompleteV3",
      "signature": "AccessCompleteV3(uint256,bool,address,bytes32,address,uint256)",
      "topic": "0xd3e5b1d14681444d8159fa85b57104b685f47fb9164fd82b7fafe4e123dcc3a1",
      "values": {
        "0": {
          "_hex": "0xde7e797f3ee454dc0637e4fa717ff114d1c58222c420acd970225a3d6b73cc85"
        },
        "1": true,
        "2": "0x97172A5190A9967238444e2e7983f934A8D40e47",
        "3": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "4": "0x665AEe2328fa4040e569e91be23Faf5A82a6186C",
        "5": {
          "_hex": "0x0178189b1d10"
        },
        "requestNonce": {
          "_hex": "0xde7e797f3ee454dc0637e4fa717ff114d1c58222c420acd970225a3d6b73cc85"
        },
        "customContractResult": true,
        "parentAddress": "0x97172A5190A9967238444e2e7983f934A8D40e47",
        "contextHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
        "accessor": "0x665AEe2328fa4040e569e91be23Faf5A82a6186C",
        "request_timestamp": {
          "_hex": "0x0178189b1d10"
        },
        "length": 6
      }
    }
  ],
  "blockNumber": 203384,
  "confirmations": 1,
  "cumulativeGasUsed": {
    "_hex": "0x9e18"
  },
  "status": 1,
  "byzantium": true
}
Source:

static ContentObjectGraph({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
autoUpdateoptional,
selectoptional
}) → Promise.<Object>

Get a specific content object in the library

Returns: Description of created object
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object -- if not specified, latest version is returned
autoUpdate boolean <optional>
 false

If true, lists only links marked as auto-update links
select string | Array.<string> <optional>

Limit metadata fields return in link details
Examples
async ContentObjectGraph({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "autoUpdate": true
});


{
  "root": {
    "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
    "hash_or_token": "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP"
  },
  "object_dag": {
    "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP": [
      "hq__KEb1KzuifJmqr6wVFDFLwMJjLNb3YJxCyNGgN9U7TiviEVPMQ2ZLZA5eknQ1rey7tvWYqsCedh"
    ],
    "hq__KEb1KzuifJmqr6wVFDFLwMJjLNb3YJxCyNGgN9U7TiviEVPMQ2ZLZA5eknQ1rey7tvWYqsCedh": []
  },
  "auto_updates": {},
  "details": {
    "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP": {
      "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
      "meta": null
    },
    "hq__KEb1KzuifJmqr6wVFDFLwMJjLNb3YJxCyNGgN9U7TiviEVPMQ2ZLZA5eknQ1rey7tvWYqsCedh": {
      "qid": "iq__24DVjj4gbe8TwRguc9f2bqXFL2Dh",
      "meta": null
    }
  }
}
async ContentObjectGraph({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "autoUpdate": true
});


{
  "root": {
    "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
    "hash_or_token": "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP"
  },
  "object_dag": {
    "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP": [
      "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX"
    ],
    "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX": []
  },
  "auto_updates": {
    "order": [
      "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP"
    ],
    "links": {
      "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP": [
        {
          "hash": "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP",
          "path": "/test/link",
          "current": {
            ".": {
              "auto_update": {
                "tag": "latest"
              }
            },
            "/": "/qfab/hq__KEb1KzuifJmqr6wVFDFLwMJjLNb3YJxCyNGgN9U7TiviEVPMQ2ZLZA5eknQ1rey7tvWYqsCedh/meta/public/asset_metadata"
          },
          "updated": {
            ".": {
              "auto_update": {
                "tag": "latest"
              }
            },
            "/": "/qfab/hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX/meta/public/asset_metadata"
          }
        }
      ]
    }
  },
  "details": {
    "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP": {
      "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
      "meta": null
    },
    "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX": {
      "qid": "iq__24DVjj4gbe8TwRguc9f2bqXFL2Dh",
      "meta": null
    }
  }
}
async ContentObjectGraph({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "autoUpdate": true,
  "select": [
    "name",
    "public/name",
    "public/asset_metadata/display_title"
  ]
});


{
  "root": {
    "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
    "hash_or_token": "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP"
  },
  "object_dag": {
    "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP": [
      "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX"
    ],
    "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX": []
  },
  "auto_updates": {
    "order": [
      "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP"
    ],
    "links": {
      "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP": [
        {
          "hash": "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP",
          "path": "/test/link",
          "current": {
            ".": {
              "auto_update": {
                "tag": "latest"
              }
            },
            "/": "/qfab/hq__KEb1KzuifJmqr6wVFDFLwMJjLNb3YJxCyNGgN9U7TiviEVPMQ2ZLZA5eknQ1rey7tvWYqsCedh/meta/public/asset_metadata"
          },
          "updated": {
            ".": {
              "auto_update": {
                "tag": "latest"
              }
            },
            "/": "/qfab/hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX/meta/public/asset_metadata"
          }
        }
      ]
    }
  },
  "details": {
    "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP": {
      "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
      "meta": {
        "name": "Test Content Object"
      }
    },
    "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX": {
      "qid": "iq__24DVjj4gbe8TwRguc9f2bqXFL2Dh",
      "meta": null
    }
  }
}
async ContentObjectGraph({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "autoUpdate": true,
  "select": [
    "name",
    "public/name",
    "public/asset_metadata/display_title"
  ]
});


{
  "root": {
    "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
    "hash_or_token": "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD"
  },
  "object_dag": {
    "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD": [
      "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX"
    ],
    "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX": []
  },
  "auto_updates": {},
  "details": {
    "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD": {
      "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
      "meta": {
        "name": "Test Content Object"
      }
    },
    "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX": {
      "qid": "iq__24DVjj4gbe8TwRguc9f2bqXFL2Dh",
      "meta": null
    }
  }
}
async ContentObjectGraph({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "autoUpdate": true
});


{
  "root": {
    "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
    "hash_or_token": "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD"
  },
  "object_dag": {
    "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD": [
      "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX"
    ],
    "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX": []
  },
  "auto_updates": {},
  "details": {
    "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD": {
      "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
      "meta": null
    },
    "hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX": {
      "qid": "iq__24DVjj4gbe8TwRguc9f2bqXFL2Dh",
      "meta": null
    }
  }
}
Source:

static ContentObjectImageUrl({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
heightoptional,
imagePathoptional
}) → Promise.<(string|undefined)>

Get the image URL for the specified object

Returns: If the object has an image, will return a URL for that image.
See:
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object -- if not specified, latest version is used
height number <optional>

If specified, the image will be scaled to the specified maximum height
imagePath string <optional>
 public/display_image

Metadata path to the image link
Example
async ContentObjectImageUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3762veoskHQtAwoUZZRX26V2qKc2"
});


"https://host-34-105-49-255.testv2.contentfabric.io/q/hq__M2cRBoY54E8erCzTj5HZUD8FzAgEPGU5Y2N7yQq6Lrgp35bQEshLZstSAQtJKMjWpwNLjAAc9L/meta/public/display_image?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4ODBlMWZiMGM2ZGY1ZTZiMjg0N2E2OTAzYjcyYTMzMTU1N2Q0ODU5MWUzY2E0MWY5MTI2NDhkOWRiZTVjODE4MSJ9.RVMyNTZLX056azNaUVRGWEVIUEFRZWNibnpUam5iM2h5SmQycWR1eEsyWWp6VmVCU2Y5ekU3b1hpbkNOV0JOS1FTdWJLaXNuMW5aY29qMk1YSmoxRFdKQ0o2YjdEeVhw&resolve=true"
Source:

static ContentObjectLibraryId({
objectIdoptional,
versionHashoptional
}) → Promise.<string>

Retrieve the library ID for the specified content object

Returns: Library ID of the object
Parameters:
Name Type Attributes Description
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object
Examples
async ContentObjectLibraryId({
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy"
});


"ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV"
async ContentObjectLibraryId({
  "objectId": "iq__3MvjYsa9bi4aywAYAXUhrvsQVHZq"
});


"ilib2wXUwatNUvPoBWtNyiyDEsEYRxX3"
async ContentObjectLibraryId({
  "versionHash": "hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP"
});


"ilib3762veoskHQtAwoUZZRX26V2qKc2"
Source:

static ContentObjectMetadata({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional,
metadataSubtreeoptional,
queryParamsoptional,
selectoptional,
removeoptional,
authorizationTokenoptional,
noAuthoptional,
resolveLinksoptional,
resolveIncludeSourceoptional,
resolveIgnoreErrorsoptional,
linkDepthLimitoptional,
produceLinkUrlsoptional
}) → Promise.<(Object|string)>

Get the metadata of a content object

Returns: Metadata of the content object
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Version of the object -- if not specified, latest version is used
writeToken string <optional>

Write token of an object draft - if specified, will read metadata from the draft
metadataSubtree string <optional>

Subtree of the object metadata to retrieve
queryParams Object <optional>
 {}

Additional query params for the call
select Array.<string> <optional>

Limit the returned metadata to the specified attributes

  • Note: Selection is relative to "metadataSubtree". For example, metadataSubtree="public" and select=["name", "description"] would select "public/name" and "public/description"
remove Array.<string> <optional>

Exclude the specified items from the retrieved metadata
authorizationToken string <optional>

Additional authorization token for this request
noAuth string <optional>
 false

If specified, the normal authorization flow will be skipped. Useful if you know the metadata you're retrieving is publicly accessible
resolveLinks boolean <optional>
 false

If specified, links in the metadata will be resolved
resolveIncludeSource boolean <optional>
 false

If specified, resolved links will include the hash of the link at the root of the metadata

Example:

   {
      "resolved-link": {
        ".": {
          "source": "hq__HPXNia6UtXyuUr6G3Lih8PyUhvYYHuyLTt3i7qSfYgYBB7sF1suR7ky7YRXsUARUrTB1Um1x5a"
        },
        "public": {
          "name": "My Linked Object",
        }
        ...
      }
   }
resolveIgnoreErrors boolean <optional>
 false

If specified, link errors within the requested metadata will not cause the entire response to result in an error
linkDepthLimit number <optional>
 1

Limit link resolution to the specified depth. Default link depth is 1 (only links directly in the object's metadata will be resolved)
produceLinkUrls boolean <optional>
 false

If specified, file and rep links will automatically be populated with a full URL
Examples
async ContentObjectMetadata({
  "libraryId": "ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV",
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy",
  "versionHash": "hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3",
  "metadataSubtree": "public/asset_metadata/sources/default"
});


{
  ".": {
    "container": "hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3"
  },
  "/": "./rep/playout/default/options.json"
}
async ContentObjectMetadata({
  "libraryId": "ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV",
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy",
  "versionHash": "hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3",
  "metadataSubtree": "public/asset_metadata/sources/default",
  "resolveLinks": false,
  "resolveIgnoreErrors": true,
  "resolveIncludeSource": true
});


{
  ".": {
    "container": "hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3"
  },
  "/": "./rep/playout/default/options.json"
}
async ContentObjectMetadata({
  "libraryId": "ilib4BRmonTig9QSD87MRWP8F5iLfdct",
  "objectId": "iq__2zvCXt22xrdJXn3ctg3TbPLk18gC",
  "metadataSubtree": "public/name",
  "queryParams": {},
  "select": [],
  "resolveLinks": false,
  "resolveIncludeSource": false,
  "resolveIgnoreErrors": false,
  "linkDepthLimit": 1
});


"Test User"
async ContentObjectMetadata({
  "libraryId": "ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV",
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy",
  "versionHash": "hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs",
  "metadataSubtree": "public/videoLink/default",
  "resolveLinks": false,
  "resolveIgnoreErrors": true,
  "resolveIncludeSource": true
});


{
  ".": {
    "container": "hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs"
  },
  "/": "./rep/playout/default/options.json"
}
async ContentObjectMetadata({
  "libraryId": "ilib4BRmonTig9QSD87MRWP8F5iLfdct",
  "objectId": "iq__2zvCXt22xrdJXn3ctg3TbPLk18gC",
  "metadataSubtree": "tenantId",
  "queryParams": {},
  "select": [],
  "resolveLinks": false,
  "resolveIncludeSource": false,
  "resolveIgnoreErrors": false,
  "linkDepthLimit": 1
});


<No Return Value>
async ContentObjectMetadata({
  "libraryId": "ilib2wXUwatNUvPoBWtNyiyDEsEYRxX3",
  "objectId": "iq__3MvjYsa9bi4aywAYAXUhrvsQVHZq",
  "versionHash": "hq__HX8rWEhiUP1koNyZvhw7ijtzpvk3Ysp7ZHuFb47Cp7vRD5GPcYxSDdAVPeXFXEyjGLHzLWXsps",
  "metadataSubtree": "public/videoLink",
  "resolveLinks": false,
  "resolveIgnoreErrors": true,
  "resolveIncludeSource": true
});


{
  ".": {
    "container": "hq__HX8rWEhiUP1koNyZvhw7ijtzpvk3Ysp7ZHuFb47Cp7vRD5GPcYxSDdAVPeXFXEyjGLHzLWXsps"
  },
  "/": "/qfab/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout/default/options.json"
}
async ContentObjectMetadata({
  "libraryId": "ilib2wXUwatNUvPoBWtNyiyDEsEYRxX3",
  "objectId": "iq__3MvjYsa9bi4aywAYAXUhrvsQVHZq",
  "versionHash": "hq__HX8rWEhiUP1koNyZvhw7ijtzpvk3Ysp7ZHuFb47Cp7vRD5GPcYxSDdAVPeXFXEyjGLHzLWXsps",
  "metadataSubtree": "public/multiOfferingVideoLink",
  "resolveLinks": false,
  "resolveIgnoreErrors": true,
  "resolveIncludeSource": true
});


{
  ".": {
    "container": "hq__HX8rWEhiUP1koNyZvhw7ijtzpvk3Ysp7ZHuFb47Cp7vRD5GPcYxSDdAVPeXFXEyjGLHzLWXsps"
  },
  "/": "/qfab/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout"
}
async ContentObjectMetadata({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "resolveLinks": true,
  "metadataSubtree": "/test/link"
});


{
  "link": {
    "target": "content"
  }
}
async ContentObjectMetadata({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


{
  "bundle_meta": {
    "extensions": null,
    "files_ingests": [],
    "files_jobs": {
      "iqfjD3USWXWsbUcdLnH5mKTCwA": {
        "encryption_public_key": "CAQF9K3rX3K6EXJy//vi6LW//azSgIh23/ulINtWqzpdcnonq0V56gnhf9RB1WAov6kQYrTpeTiH/8CubIDfDLn9JVoEzfaVxPurFRi8s63OmbANX9XgwWC3eO18MQ/S300=",
        "id": "iqfjD3USWXWsbUcdLnH5mKTCwA",
        "ingestor": {
          "ingest_progress": {
            "bytes_written": 100094370,
            "completed_files": 1,
            "completed_references": 0,
            "failed_files": 0,
            "files": {},
            "total_bytes": 100094370,
            "total_files": 1,
            "total_references": 0
          },
          "status": {
            "download": {
              "in": 4,
              "out": 4,
              "status": "completed"
            },
            "resolve": {
              "in": 1,
              "out": 1,
              "status": "completed"
            }
          }
        },
        "reqs": [
          {
            "processed": true,
            "processing": false,
            "req": {
              "defaults": null,
              "ops": [
                {
                  "encryption": {
                    "scheme": "cgck"
                  },
                  "ingest": {
                    "etag": "",
                    "path": "/eluvio-mez-test/ENTIRE_CREED_2min_.mp4",
                    "size": 0,
                    "type": "key"
                  },
                  "op": "ingest-copy",
                  "path": "s3-copy-encrypted",
                  "size": 0,
                  "type": "file"
                }
              ],
              "seq": 0,
              "seq_complete": true
            }
          }
        ],
        "status": {
          "jobs_status": 5,
          "max_seq": 0,
          "rcv_complete": true,
          "req_complete": true
        },
        "upload_jobs": [
          "iqfuAxw9X4gBbBnjohqDuaFceH",
          "iqfu3UQ6k3TBCdZrE9qmw355wb",
          "iqfuXZ3bKgi6fSZDit7L9WEWfv",
          "iqfu2NozhDqNH2ew8rzJw8TEM6"
        ]
      },
      "iqfjJaGNEhyopNVKTnsjDKqF2j": {
        "id": "iqfjJaGNEhyopNVKTnsjDKqF2j",
        "ingestor": {
          "ingest_progress": {
            "bytes_written": 97944174,
            "completed_files": 1,
            "completed_references": 0,
            "failed_files": 0,
            "files": {},
            "total_bytes": 97944174,
            "total_files": 1,
            "total_references": 0
          },
          "status": {
            "download": {
              "in": 3,
              "out": 3,
              "status": "completed"
            },
            "resolve": {
              "in": 1,
              "out": 1,
              "status": "completed"
            }
          }
        },
        "reqs": [
          {
            "processed": true,
            "processing": false,
            "req": {
              "defaults": null,
              "ops": [
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "ingest": {
                    "etag": "",
                    "path": "/eluvio-mez-test/ENTIRE_CREED_2min_.mp4",
                    "size": 0,
                    "type": "key"
                  },
                  "op": "ingest-copy",
                  "path": "s3-copy",
                  "size": 0,
                  "type": "file"
                }
              ],
              "seq": 0,
              "seq_complete": true
            }
          }
        ],
        "status": {
          "jobs_status": 5,
          "max_seq": 0,
          "rcv_complete": true,
          "req_complete": true
        },
        "upload_jobs": [
          "iqfuD7nhUTajFdnyVhY5HHzubL",
          "iqfuNrpBfp3uxm9MSXWfUxVErU",
          "iqfu8SHTqNJTmLwugwcFsAo6Aq"
        ]
      },
      "iqfjKtr738S93t2JahZMfwRToq": {
        "defaults": {
          "op": "add"
        },
        "id": "iqfjKtr738S93t2JahZMfwRToq",
        "reqs": [
          {
            "processed": true,
            "processing": false,
            "req": {
              "defaults": null,
              "ops": [
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "mime_type": "text/plain",
                  "op": "add",
                  "path": "testDirectory/File 1",
                  "size": 100000,
                  "type": "file"
                },
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "mime_type": "text/plain",
                  "op": "add",
                  "path": "testDirectory/File 2",
                  "size": 100000,
                  "type": "file"
                }
              ],
              "seq": 0,
              "seq_complete": true
            }
          }
        ],
        "status": {
          "jobs_status": 5,
          "max_seq": 0,
          "rcv_complete": true,
          "req_complete": true
        },
        "upload_jobs": [
          "iqfuKQ1c7xreTb3RjumG3rMXVg"
        ]
      },
      "iqfjM97Xh1fvLwT9X49gTNbV32": {
        "defaults": {
          "op": "add"
        },
        "id": "iqfjM97Xh1fvLwT9X49gTNbV32",
        "reqs": [
          {
            "processed": true,
            "processing": false,
            "req": {
              "defaults": null,
              "ops": [
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "op": "add",
                  "path": "new-directory-1",
                  "size": 0,
                  "type": "directory"
                },
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "op": "add",
                  "path": "new-directory-2",
                  "size": 0,
                  "type": "directory"
                },
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "op": "add",
                  "path": "new-directory-3",
                  "size": 0,
                  "type": "directory"
                }
              ],
              "seq": 0,
              "seq_complete": true
            }
          }
        ],
        "status": {
          "jobs_status": 5,
          "max_seq": 0,
          "rcv_complete": true,
          "req_complete": true
        }
      },
      "iqfjSaECTEkrMEWeEB43xYPtRP": {
        "defaults": {
          "op": "add"
        },
        "id": "iqfjSaECTEkrMEWeEB43xYPtRP",
        "reqs": [
          {
            "processed": true,
            "processing": false,
            "req": {
              "defaults": null,
              "ops": [
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "op": "del",
                  "path": "new-directory-1",
                  "size": 0,
                  "type": "file"
                },
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "op": "del",
                  "path": "new-directory-2",
                  "size": 0,
                  "type": "file"
                },
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "op": "del",
                  "path": "testDirectory/File 2",
                  "size": 0,
                  "type": "file"
                }
              ],
              "seq": 0,
              "seq_complete": true
            }
          }
        ],
        "status": {
          "jobs_status": 5,
          "max_seq": 0,
          "rcv_complete": true,
          "req_complete": true
        }
      },
      "iqfjVxdQ566cMuHE1Q4aRyRoEA": {
        "id": "iqfjVxdQ566cMuHE1Q4aRyRoEA",
        "ingestor": {
          "ingest_progress": {
            "bytes_written": 0,
            "completed_files": 0,
            "completed_references": 1,
            "failed_files": 0,
            "files": {},
            "total_bytes": 0,
            "total_files": 0,
            "total_references": 1
          },
          "status": {
            "download": {
              "in": 0,
              "out": 0,
              "status": "completed"
            },
            "resolve": {
              "in": 1,
              "out": 1,
              "status": "completed"
            }
          }
        },
        "reqs": [
          {
            "processed": true,
            "processing": false,
            "req": {
              "defaults": null,
              "ops": [
                {
                  "encryption": {
                    "scheme": "none"
                  },
                  "op": "add-reference",
                  "path": "s3-reference",
                  "reference": {
                    "etag": "",
                    "path": "/eluvio-mez-test/ENTIRE_CREED_2min_.mp4",
                    "size": 0,
                    "type": "key"
                  },
                  "size": 0,
                  "type": "file"
                }
              ],
              "seq": 0,
              "seq_complete": true
            }
          }
        ],
        "status": {
          "jobs_status": 5,
          "max_seq": 0,
          "rcv_complete": true,
          "req_complete": true
        }
      }
    },
    "finalized": true,
    "pack_policy": "compact",
    "part_refs": {
      "hqp_21EGs7Qn1YPPSN16C1BsX12Fj7ZcJdSe5gJ7XbGy8CFSJLfXHy": 1,
      "hqp_2CGYfTCAZ4PPtaMJzXYqJNuLiDV9SHJPhTmJyc17vg2gzMT9HX": 1,
      "hqp_Gj4MmdotDRVL9cBde82AjfzvXh8gRCGRLDf1it73EmbpbcAP": 3,
      "hqp_weywY8hZN6DtGon3FGUnqmc5iqDsdZP3GGYVcsfHDfVKrMmsV": 1,
      "hqpe23EKpg1XdrZg6XoXqgHo2tEhN6LcCtog1Kgn5ivnJKuqmf7y74": 1,
      "hqpe28AZ3dn4FPnJwdiFHy4QT26fuQ9HXQ3qXrWhkRU1La12ffiM7U": 1,
      "hqpe2QRZeCYqyFRg1qCArYqBmYuazGkoucc2PSaVviYqC9wctNPPok": 1,
      "hqpeQtmBKbfTrcTybr8DqQYrfteMjkth2yTpz1jR6PGTuuYekN5v": 1
    },
    "segments": [
      {
        "hash": "hqp_Gj4MmdotDRVL9cBde82AjfzvXh8gRCGRLDf1it73EmbpbcAP",
        "len": 100000,
        "off": 0
      },
      {
        "hash": "hqp_Gj4MmdotDRVL9cBde82AjfzvXh8gRCGRLDf1it73EmbpbcAP",
        "len": 100000,
        "off": 100000
      },
      {
        "hash": "hqp_21EGs7Qn1YPPSN16C1BsX12Fj7ZcJdSe5gJ7XbGy8CFSJLfXHy",
        "len": 33554432,
        "off": 0
      },
      {
        "hash": "hqp_weywY8hZN6DtGon3FGUnqmc5iqDsdZP3GGYVcsfHDfVKrMmsV",
        "len": 33554432,
        "off": 0
      },
      {
        "hash": "hqp_2CGYfTCAZ4PPtaMJzXYqJNuLiDV9SHJPhTmJyc17vg2gzMT9HX",
        "len": 30835310,
        "off": 0
      },
      {
        "hash": "hqpe28AZ3dn4FPnJwdiFHy4QT26fuQ9HXQ3qXrWhkRU1La12ffiM7U",
        "len": 32702496,
        "off": 0
      },
      {
        "hash": "hqpe2QRZeCYqyFRg1qCArYqBmYuazGkoucc2PSaVviYqC9wctNPPok",
        "len": 32702496,
        "off": 0
      },
      {
        "hash": "hqpe23EKpg1XdrZg6XoXqgHo2tEhN6LcCtog1Kgn5ivnJKuqmf7y74",
        "len": 32702496,
        "off": 0
      },
      {
        "hash": "hqpeQtmBKbfTrcTybr8DqQYrfteMjkth2yTpz1jR6PGTuuYekN5v",
        "len": 1986882,
        "off": 0
      }
    ],
    "upload_jobs_count": 0
  },
  "commit": {
    "author": "Test User",
    "author_address": "0x665aee2328fa4040e569e91be23faf5a82a6186c",
    "message": "Update links",
    "timestamp": "2021-03-09T20:08:27.930Z"
  },
  "eluv.caps.ikms4ZPRRaZiwQN6rxEz7D75tqzvGQ3g": "BEMkx/SuXFnYiSdNkXkbSPaVfWAHOKOsEHm7WS1DsYGXI+teWCGXDmqGbdNZY+fQ9PF/JoSgMghf9wicgdGLwYWxrOs87hdFSK5VeaggvCRviMh37ow2I9zVFfbRP/B+JnVVMXU29PZ6rwQjsLqR4vQW5mQWz0dchiUS9cEtqADZ+r2y2dssoMVaZpM7eglhdJuzAdGNcd9FIgD9XNlVk5qBEPQ0ehPkzDCPrUUN81TsZSuPtegweeXbzwBz1Jd9hcEzK3vfQtkTc6Y+XkyWRF+RhzveGTVAsawobJvgD2On4pG69KuoVZu2jjYhQnnrJPcoo6gW2oT9dYllpMoYY0cCGE1np1JAHfRTzym08ixnNxSLPB+Hf6nfALLNCy/4pLeDGMjyhRg0h1Cjqn2BhRsarI/2LY7Z8ne6hwf8WI1vF5DbvAL434EK+ufj82a7sO+Mvef3HS5vqcaCQFi7MsifAuRlqHsdsZ/0eny8XmCBvJB+UtIRKNo+WFzljztLahg2uPZH86yhMuvQjSAGoqYmMiJVxxOH6HNXG8UC0ypBZE/Tyns1MDImJlGtoxgyPngij66ilXry9mJjzs1u3A8=",
  "eluv.caps.iusr2Rhzo3zuzt78fchPSDHdTwEvGB4F": "BHTRU7hh0mLdITqwZdPOqC8va5rMjamsbK/FW0JtjW2m/a4aELsyO5SzONaakOB45NlAu0Fym6B+MVCk/HPe64t1YhBshxutSxf+JLlvayqoLUl+gIUltF7fxXfEt8RZfsMF9t0wOjGrmpJtjDmRSYLCgFHyl/ZSMvINlwMJbhMOM89m6aq9BzdiRHytzbgh6GniZ6sk9JWG1DNAiFHGvKYI2KDl7b66DLAQSf2KdFBl8BLsjLRYX5ZTdGW876mS8AOA2s4ROzFgdJdRFlGS+xDAsVC1PyWKnSZVt/Q7lhY8rGmdRsWBHNnnQxMXd1x3e/S7So+n5jUVMhOmjCE+FZCRmUY4NncADBoP8wkEKj0/Q02RbfjalWanHiTkz1WEdC5+rZ2iR56wOjc0ie8SZJaSVGj+JYyzOUY0aBLx0ixo18Y/zPN2XWAYhlAuiirGWHAxBX/tKBOK87OCCFupKncb5bP9Cq1idNBCB07Cy4gof5l81TFZhkONlYH4PxgP+Zcpmqa2WAxAgjYtaRZCPRufpPI7JufXpPxJEnD8deBN3740PGj2LONF5MzQ1zfZ1cqW/8gSwR870EWkbTNEtcM=",
  "files": {
    ".": {
      "type": "directory"
    },
    "new-directory-3": {
      ".": {
        "type": "directory"
      }
    },
    "s3-copy": {
      ".": {
        "encryption": {
          "scheme": "none"
        },
        "ingest": {
          "etag": "5c689030274ecfd14a815c8672b9f723-12",
          "path": "/eluvio-mez-test/ENTIRE_CREED_2min_.mp4",
          "size": 97944174,
          "type": "key"
        },
        "parts": [
          2,
          3,
          4
        ],
        "size": 97944174
      }
    },
    "s3-copy-encrypted": {
      ".": {
        "encryption": {
          "scheme": "cgck"
        },
        "ingest": {
          "etag": "5c689030274ecfd14a815c8672b9f723-12",
          "path": "/eluvio-mez-test/ENTIRE_CREED_2min_.mp4",
          "size": 97944174,
          "type": "key"
        },
        "parts": [
          5,
          6,
          7,
          8
        ],
        "size": 100094370
      }
    },
    "s3-reference": {
      ".": {
        "encryption": {
          "scheme": "none"
        },
        "reference": {
          "etag": "5c689030274ecfd14a815c8672b9f723-12",
          "path": "/eluvio-mez-test/ENTIRE_CREED_2min_.mp4",
          "size": 97944174,
          "type": "key"
        },
        "size": 97944174
      }
    },
    "testDirectory": {
      ".": {
        "type": "directory"
      },
      "File 1": {
        ".": {
          "encryption": {
            "scheme": "none"
          },
          "mime_type": "text/plain",
          "parts": [
            0
          ],
          "size": 100000
        }
      }
    }
  },
  "links": {
    "metadataLink": {
      ".": {
        "container": "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD"
      },
      "/": "./meta/toLink/meta/data"
    },
    "myLink2": {
      ".": {
        "container": "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD"
      },
      "/": "./files/testDirectory/File 2"
    }
  },
  "mime-types": {
    "": "application/octet-stream"
  },
  "myLink": {
    ".": {
      "container": "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD"
    },
    "/": "./files/testDirectory/File 1"
  },
  "name": "Test Content Object",
  "test": {
    "link": {
      ".": {
        "auto_update": {
          "tag": "latest"
        },
        "container": "hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD"
      },
      "/": "/qfab/hq__H6ygcx5tCcQmK84W6fjAxVEJk7jj1uy4D4KKb9wd1TuArvb44UkGvELtxNbbnersvkzuiN1ukX/meta/public/asset_metadata"
    }
  },
  "toLink": {
    "meta": {
      "data": {
        "data": {
          "to": "show"
        },
        "some": "meta"
      }
    }
  },
  "toMerge": {
    "merge": "me",
    "new": "metadata"
  },
  "toReplace": {
    "new": "metadata"
  }
}
async ContentObjectMetadata({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "metadataSubtree": "files/file"
});


<No Return Value>
async ContentObjectMetadata({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "metadataSubtree": "files/dir/file"
});


<No Return Value>
async ContentObjectMetadata({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "metadataSubtree": "files/file"
});


<No Return Value>
async ContentObjectMetadata({
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "metadataSubtree": "files/file"
});


<No Return Value>
Source:

static ContentObjectOwner({libraryId}) → Promise.<string>

Returns the address of the owner of the specified content object

Returns: The account address of the owner
Parameters:
Name Type Description
libraryId string
Examples
async ContentObjectOwner({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


"0x665aee2328fa4040e569e91be23faf5a82a6186c"
async ContentObjectOwner({
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


"0x665aee2328fa4040e569e91be23faf5a82a6186c"
Source:

static ContentObjectTenantId({
objectIdoptional,
versionHashoptional
}) → Promise.<string>

Retrieve the tenant ID associated with the specified content object

Returns: Tenant ID of the object
Parameters:
Name Type Attributes Description
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object
Source:

static ContentObjectVersions({
libraryId,
objectId
}) → Promise.<Object>

List the versions of a content object

Returns: Response containing versions of the object
Parameters:
Name Type Description
libraryId string

ID of the library
objectId string

ID of the object
Example
async ContentObjectVersions({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


{
  "id": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "versions": [
    {
      "id": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
      "hash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
      "type": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
      "qlib_id": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
    },
    {
      "id": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
      "hash": "hq__DjRBnasUauP1zQLbqf3x3xqCwEzFjB9cad7wf3FjA6vgm5kJVNpGVLgXxLJBRi6VC25uC7pAXK",
      "type": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
      "qlib_id": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
    }
  ]
}
Source:

static ContentObjects({
libraryId,
filterOptionsoptional
}) → Promise.<Array.<Object>>

List content objects in the specified library

Returns: List of objects in library
Parameters:
Name Type Attributes Description
libraryId string

ID of the library
filterOptions object <optional>

Pagination, sorting and filtering options

Properties
Name Type Attributes Description
start number <optional>

Start index for pagination
limit number <optional>

Max number of objects to return
sort Array.<string> | string <optional>

Sort by the specified key(s)
sortDesc boolean <optional>

Sort in descending order
select Array.<string> | string <optional>

Include only the specified metadata keys (all must start with /public)
filter Array.<object> | object <optional>

Filter objects by metadata

Properties
Name Type Attributes Description
key string <optional>

Key to filter on (must start with /public)
type string <optional>

Type of filter to use for the specified key:

  • eq, neq, lt, lte, gt, gte, cnt (contains), ncnt (does not contain),
filter string <optional>

Filter for the specified key
Examples
async ContentObjects({
  "libraryId": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
  "filterOptions": {
    "select": [
      "/public"
    ],
    "limit": 10
  }
});


{
  "contents": [
    {
      "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
      "versions": [
        {
          "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
          "hash": "hq__4ZZTmjyDP422sjhXESrqmB321Y7SUqw84nivqGMKPT54beJkbM5QBngV9VzSYrzbGDdVM2T16r",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 8",
              "otherKey": 2
            }
          }
        }
      ]
    },
    {
      "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
      "versions": [
        {
          "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
          "hash": "hq__BYs4r2cCq4oWPJuELFrvNjwbD2U9r9LByFJfYSrSXMxGFMYwxV7j62b5iszYo3oSNkGD9SrCsx",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 7",
              "otherKey": 3
            }
          }
        }
      ]
    },
    {
      "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
      "versions": [
        {
          "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
          "hash": "hq__4edMiTrSvgQrMgrf3UjzJGF56qeDbN6kmnzdrvcjtjpPemnDXPkDDP1CZniVaxPtX2hS2botHT",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 6",
              "otherKey": 4
            }
          }
        }
      ]
    },
    {
      "id": "iq__3FXPgTwwdhKjJb4PpwZ6y1JJb836",
      "versions": [
        {
          "id": "iq__3FXPgTwwdhKjJb4PpwZ6y1JJb836",
          "hash": "hq__CDYmPZePcAs5LoHnzpjQVUVT7UPu1abSNe1aZJWzz18ysm98tdUbRhgBK9FckDgZG46SAxb452",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 9",
              "otherKey": 1
            }
          }
        }
      ]
    },
    {
      "id": "iq__Asyv7iKs1525Gz6oshLQBecb62E",
      "versions": [
        {
          "id": "iq__Asyv7iKs1525Gz6oshLQBecb62E",
          "hash": "hq__7cgdCPKu4MJeUa9XiTKUKF9G9RNC8z3BhdNwJVSo5rpBWAAk28ZE77Gym3tDX7bGTMv21ABc8z",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 10",
              "otherKey": 0
            }
          }
        }
      ]
    }
  ],
  "paging": {
    "cached": false,
    "next": 0,
    "previous": 0,
    "first": 0,
    "last": 0,
    "current": 0,
    "pages": 1,
    "limit": 10,
    "items": 5
  }
}
async ContentObjects({
  "libraryId": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
  "filterOptions": {
    "select": [
      "/public"
    ],
    "sort": "/public/name"
  }
});


{
  "contents": [
    {
      "id": "iq__Asyv7iKs1525Gz6oshLQBecb62E",
      "versions": [
        {
          "id": "iq__Asyv7iKs1525Gz6oshLQBecb62E",
          "hash": "hq__7cgdCPKu4MJeUa9XiTKUKF9G9RNC8z3BhdNwJVSo5rpBWAAk28ZE77Gym3tDX7bGTMv21ABc8z",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 10",
              "otherKey": 0
            }
          }
        }
      ]
    },
    {
      "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
      "versions": [
        {
          "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
          "hash": "hq__4edMiTrSvgQrMgrf3UjzJGF56qeDbN6kmnzdrvcjtjpPemnDXPkDDP1CZniVaxPtX2hS2botHT",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 6",
              "otherKey": 4
            }
          }
        }
      ]
    },
    {
      "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
      "versions": [
        {
          "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
          "hash": "hq__BYs4r2cCq4oWPJuELFrvNjwbD2U9r9LByFJfYSrSXMxGFMYwxV7j62b5iszYo3oSNkGD9SrCsx",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 7",
              "otherKey": 3
            }
          }
        }
      ]
    },
    {
      "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
      "versions": [
        {
          "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
          "hash": "hq__4ZZTmjyDP422sjhXESrqmB321Y7SUqw84nivqGMKPT54beJkbM5QBngV9VzSYrzbGDdVM2T16r",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 8",
              "otherKey": 2
            }
          }
        }
      ]
    },
    {
      "id": "iq__3FXPgTwwdhKjJb4PpwZ6y1JJb836",
      "versions": [
        {
          "id": "iq__3FXPgTwwdhKjJb4PpwZ6y1JJb836",
          "hash": "hq__CDYmPZePcAs5LoHnzpjQVUVT7UPu1abSNe1aZJWzz18ysm98tdUbRhgBK9FckDgZG46SAxb452",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 9",
              "otherKey": 1
            }
          }
        }
      ]
    }
  ],
  "paging": {
    "cached": true,
    "next": 0,
    "previous": 0,
    "first": 0,
    "last": 0,
    "current": 0,
    "pages": 1,
    "limit": 100,
    "items": 5
  }
}
async ContentObjects({
  "libraryId": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
  "filterOptions": {
    "select": [
      "/public"
    ],
    "sort": "/public/name",
    "sortDesc": true
  }
});


{
  "contents": [
    {
      "id": "iq__3FXPgTwwdhKjJb4PpwZ6y1JJb836",
      "versions": [
        {
          "id": "iq__3FXPgTwwdhKjJb4PpwZ6y1JJb836",
          "hash": "hq__CDYmPZePcAs5LoHnzpjQVUVT7UPu1abSNe1aZJWzz18ysm98tdUbRhgBK9FckDgZG46SAxb452",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 9",
              "otherKey": 1
            }
          }
        }
      ]
    },
    {
      "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
      "versions": [
        {
          "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
          "hash": "hq__4ZZTmjyDP422sjhXESrqmB321Y7SUqw84nivqGMKPT54beJkbM5QBngV9VzSYrzbGDdVM2T16r",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 8",
              "otherKey": 2
            }
          }
        }
      ]
    },
    {
      "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
      "versions": [
        {
          "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
          "hash": "hq__BYs4r2cCq4oWPJuELFrvNjwbD2U9r9LByFJfYSrSXMxGFMYwxV7j62b5iszYo3oSNkGD9SrCsx",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 7",
              "otherKey": 3
            }
          }
        }
      ]
    },
    {
      "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
      "versions": [
        {
          "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
          "hash": "hq__4edMiTrSvgQrMgrf3UjzJGF56qeDbN6kmnzdrvcjtjpPemnDXPkDDP1CZniVaxPtX2hS2botHT",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 6",
              "otherKey": 4
            }
          }
        }
      ]
    },
    {
      "id": "iq__Asyv7iKs1525Gz6oshLQBecb62E",
      "versions": [
        {
          "id": "iq__Asyv7iKs1525Gz6oshLQBecb62E",
          "hash": "hq__7cgdCPKu4MJeUa9XiTKUKF9G9RNC8z3BhdNwJVSo5rpBWAAk28ZE77Gym3tDX7bGTMv21ABc8z",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 10",
              "otherKey": 0
            }
          }
        }
      ]
    }
  ],
  "paging": {
    "cached": true,
    "next": 0,
    "previous": 0,
    "first": 0,
    "last": 0,
    "current": 0,
    "pages": 1,
    "limit": 100,
    "items": 5
  }
}
async ContentObjects({
  "libraryId": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
  "filterOptions": {
    "select": [
      "/public"
    ],
    "sort": [
      "/public/name"
    ],
    "filter": [
      {
        "key": "/public/name",
        "type": "gte",
        "filter": "Test Object 6"
      },
      {
        "key": "/public/name",
        "type": "lte",
        "filter": "Test Object 8"
      }
    ]
  }
});


{
  "contents": [
    {
      "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
      "versions": [
        {
          "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
          "hash": "hq__4edMiTrSvgQrMgrf3UjzJGF56qeDbN6kmnzdrvcjtjpPemnDXPkDDP1CZniVaxPtX2hS2botHT",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 6",
              "otherKey": 4
            }
          }
        }
      ]
    },
    {
      "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
      "versions": [
        {
          "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
          "hash": "hq__BYs4r2cCq4oWPJuELFrvNjwbD2U9r9LByFJfYSrSXMxGFMYwxV7j62b5iszYo3oSNkGD9SrCsx",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 7",
              "otherKey": 3
            }
          }
        }
      ]
    },
    {
      "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
      "versions": [
        {
          "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
          "hash": "hq__4ZZTmjyDP422sjhXESrqmB321Y7SUqw84nivqGMKPT54beJkbM5QBngV9VzSYrzbGDdVM2T16r",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 8",
              "otherKey": 2
            }
          }
        }
      ]
    }
  ],
  "paging": {
    "cached": true,
    "next": 0,
    "previous": 0,
    "first": 0,
    "last": 0,
    "current": 0,
    "pages": 1,
    "limit": 100,
    "items": 3
  }
}
async ContentObjects({
  "libraryId": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
  "filterOptions": {
    "sort": "/public/name",
    "select": [
      "/public/name"
    ]
  }
});


{
  "contents": [
    {
      "id": "iq__Asyv7iKs1525Gz6oshLQBecb62E",
      "versions": [
        {
          "id": "iq__Asyv7iKs1525Gz6oshLQBecb62E",
          "hash": "hq__7cgdCPKu4MJeUa9XiTKUKF9G9RNC8z3BhdNwJVSo5rpBWAAk28ZE77Gym3tDX7bGTMv21ABc8z",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 10"
            }
          }
        }
      ]
    },
    {
      "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
      "versions": [
        {
          "id": "iq__2okFxXRxmdEEwfvHhEicqsCus5h7",
          "hash": "hq__4edMiTrSvgQrMgrf3UjzJGF56qeDbN6kmnzdrvcjtjpPemnDXPkDDP1CZniVaxPtX2hS2botHT",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 6"
            }
          }
        }
      ]
    },
    {
      "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
      "versions": [
        {
          "id": "iq__2Xf8sNgu4RqbYjMtrwQgKYKT2HkA",
          "hash": "hq__BYs4r2cCq4oWPJuELFrvNjwbD2U9r9LByFJfYSrSXMxGFMYwxV7j62b5iszYo3oSNkGD9SrCsx",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 7"
            }
          }
        }
      ]
    },
    {
      "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
      "versions": [
        {
          "id": "iq__2XEjKuQwsuxHxdsW3ZY5k2Fgsojx",
          "hash": "hq__4ZZTmjyDP422sjhXESrqmB321Y7SUqw84nivqGMKPT54beJkbM5QBngV9VzSYrzbGDdVM2T16r",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 8"
            }
          }
        }
      ]
    },
    {
      "id": "iq__3FXPgTwwdhKjJb4PpwZ6y1JJb836",
      "versions": [
        {
          "id": "iq__3FXPgTwwdhKjJb4PpwZ6y1JJb836",
          "hash": "hq__CDYmPZePcAs5LoHnzpjQVUVT7UPu1abSNe1aZJWzz18ysm98tdUbRhgBK9FckDgZG46SAxb452",
          "type": "",
          "qlib_id": "ilibUjiUGsGnnjuGAzSLZrhCDTcddX4",
          "meta": {
            "public": {
              "name": "Test Object 9"
            }
          }
        }
      ]
    }
  ],
  "paging": {
    "cached": true,
    "next": 0,
    "previous": 0,
    "first": 0,
    "last": 0,
    "current": 0,
    "pages": 1,
    "limit": 100,
    "items": 5
  }
}
Source:

static ContentSpaceId() → string

Get the ID of the current content space

Returns:

contentSpaceId - The ID of the current content space
Source:

static ContentType({
nameoptional,
typeIdoptional,
versionHashoptional,
publicOnlyoptional
}) → Promise.<Object>

Find the content type accessible to the current user by name, ID, or version hash

Returns: The content type, if found
Parameters:
Name Type Attributes Default Description
name string <optional>

Name of the content type to find
typeId string <optional>

ID of the content type to find
versionHash string <optional>

Version hash of the content type to find
publicOnly boolean <optional>
 false

If specified, will only retrieve public metadata (no access request needed)
Examples
async ContentType({
  "typeId": "iq__3tCKL1zJ2a2XqG5xktRDCoEMzVZv",
  "publicOnly": true
});


{
  "id": "iq__3tCKL1zJ2a2XqG5xktRDCoEMzVZv",
  "hash": "hq__J39WocoEB1hc19t3o1YUaZM2PAzhRvLck6NVmFFviSTRM5yvVTcJ4SJeULw3VarH6mD6xkfjaC",
  "name": "ABR Master",
  "meta": {
    "public": {
      "description": "",
      "eluv.displayApp": "default",
      "eluv.manageApp": "default",
      "name": "ABR Master"
    }
  }
}
async ContentType({
  "typeId": "iq__fTEG7r9sPawZpWqmyNxGMbdm5WR",
  "publicOnly": true
});


{
  "id": "iq__fTEG7r9sPawZpWqmyNxGMbdm5WR",
  "hash": "hq__3MVUz8NbMXRUqR6LjUKzGgM1H43ZXWzPFYNp32Qs9f5Jb9QrFJXPX57qiXLUQdkQpJgb9yhwSR",
  "name": "AVLive",
  "meta": {
    "public": {
      "description": "",
      "eluv.displayApp": "default",
      "eluv.manageApp": "manageApp/index.html",
      "name": "AVLive"
    }
  }
}
async ContentType({
  "typeId": "iq__T3CydLkQyiCDz3MrAumhRW7uazH",
  "publicOnly": true
});


{
  "id": "iq__T3CydLkQyiCDz3MrAumhRW7uazH",
  "hash": "hq__7ywcAZ5Ac9rSJGTMErYj47nQpVbcz6BWVrS7oFfEASiUL2BQRxnEHj2QCYCJvQS115Djk9Nsgy",
  "name": "Library",
  "meta": {
    "public": {
      "description": "",
      "name": "Library"
    }
  }
}
async ContentType({
  "typeId": "iq__RCFsiwubUs5bqeCwohR2wv1P4Q5",
  "publicOnly": true
});


{
  "id": "iq__RCFsiwubUs5bqeCwohR2wv1P4Q5",
  "hash": "hq__E1nPgLBeDKWd4S25fGmSMmxQE7DzRTfMuc6j85duh2AJityFYTx9sig2vVXjXEYsVRsgrKioSm",
  "name": "Channel",
  "meta": {
    "public": {
      "description": "",
      "eluv.displayApp": "displayApp/index.html",
      "eluv.manageApp": "manageApp/index.html",
      "name": "Channel"
    }
  }
}
async ContentType({
  "typeId": "iq__wkpaYK5tZwEBHdNyjyhw5SxRnYy",
  "publicOnly": true
});


{
  "id": "iq__wkpaYK5tZwEBHdNyjyhw5SxRnYy",
  "hash": "hq__AsSK6q2Jh8vetffArMHiyMhEgQD4fyni1g5PgeBSPcKERMJv5hbuyAd3aNQTaeJD9ounyKTUEu",
  "name": "Production Master",
  "meta": {
    "public": {
      "description": "",
      "name": "Production Master"
    }
  }
}
async ContentType({
  "typeId": "iq__y8YShB4kZWb2vQq2tvHx7wg3TLy",
  "publicOnly": true
});


{
  "id": "iq__y8YShB4kZWb2vQq2tvHx7wg3TLy",
  "hash": "hq__mFfQ45h5Z5p2oZ3TMG4UaEf3xoU1hZnyfQPeWNuhoiYehUZ4cGqWH2HXNf9frjroZCeZYutWZ",
  "name": "Linear Channel",
  "meta": {
    "public": {
      "description": "",
      "eluv.displayApp": "displayApp/index.html",
      "eluv.manageApp": "manageApp/index.html",
      "name": "Linear Channel"
    }
  }
}
async ContentType({
  "name": "ABR Master"
});


{
  "id": "iq__3tCKL1zJ2a2XqG5xktRDCoEMzVZv",
  "hash": "hq__J39WocoEB1hc19t3o1YUaZM2PAzhRvLck6NVmFFviSTRM5yvVTcJ4SJeULw3VarH6mD6xkfjaC",
  "name": "ABR Master",
  "meta": {
    "public": {
      "description": "",
      "eluv.displayApp": "default",
      "eluv.manageApp": "default",
      "name": "ABR Master"
    }
  }
}
async ContentType({
  "name": "Production Master"
});


{
  "id": "iq__wkpaYK5tZwEBHdNyjyhw5SxRnYy",
  "hash": "hq__AsSK6q2Jh8vetffArMHiyMhEgQD4fyni1g5PgeBSPcKERMJv5hbuyAd3aNQTaeJD9ounyKTUEu",
  "name": "Production Master",
  "meta": {
    "public": {
      "description": "",
      "name": "Production Master"
    }
  }
}
async ContentType({
  "name": "Library"
});


{
  "id": "iq__T3CydLkQyiCDz3MrAumhRW7uazH",
  "hash": "hq__7ywcAZ5Ac9rSJGTMErYj47nQpVbcz6BWVrS7oFfEASiUL2BQRxnEHj2QCYCJvQS115Djk9Nsgy",
  "name": "Library",
  "meta": {
    "public": {
      "description": "",
      "name": "Library"
    }
  }
}
async ContentType({
  "typeId": "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4",
  "publicOnly": true
});


{
  "id": "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4",
  "hash": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
  "name": "Test Content Type ccabade66b8fa5924627",
  "meta": {
    "public": {
      "name": "Test Content Type ccabade66b8fa5924627"
    }
  }
}
async ContentType({
  "typeId": "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4"
});


{
  "id": "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4",
  "hash": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
  "name": "Test Content Type ccabade66b8fa5924627",
  "meta": {
    "bitcode_part": "hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR",
    "commit": {
      "author": "0x665aee2328fa4040e569e91be23faf5a82a6186c",
      "author_address": "0x665aee2328fa4040e569e91be23faf5a82a6186c",
      "message": "Create content type",
      "timestamp": "2021-03-09T20:00:47.030Z"
    },
    "name": "Test Content Type ccabade66b8fa5924627",
    "public": {
      "name": "Test Content Type ccabade66b8fa5924627"
    }
  }
}
async ContentType({
  "name": "Test Content Type ccabade66b8fa5924627"
});


{
  "id": "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4",
  "hash": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
  "name": "Test Content Type ccabade66b8fa5924627",
  "meta": {
    "public": {
      "name": "Test Content Type ccabade66b8fa5924627"
    }
  }
}
async ContentType({
  "versionHash": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8"
});


{
  "id": "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4",
  "hash": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
  "name": "Test Content Type ccabade66b8fa5924627",
  "meta": {
    "bitcode_part": "hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR",
    "commit": {
      "author": "0x665aee2328fa4040e569e91be23faf5a82a6186c",
      "author_address": "0x665aee2328fa4040e569e91be23faf5a82a6186c",
      "message": "Create content type",
      "timestamp": "2021-03-09T20:00:47.030Z"
    },
    "name": "Test Content Type ccabade66b8fa5924627",
    "public": {
      "name": "Test Content Type ccabade66b8fa5924627"
    }
  }
}
async ContentType({
  "name": "Invalid Type Name"
});


<No Return Value>
Source:

static ContentTypeOwner({
nameoptional,
typeIdoptional,
versionHashoptional
}) → Promise.<string>

Returns the address of the owner of the specified content type

Returns: The account address of the owner
Parameters:
Name Type Attributes Description
name string <optional>

Name of the content type to find
typeId string <optional>

ID of the content type to find
versionHash string <optional>

Version hash of the content type to find
Example
async ContentTypeOwner({
  "name": "Test Content Type ccabade66b8fa5924627"
});


"0x665aee2328fa4040e569e91be23faf5a82a6186c"
Source:

static ContentTypes({}) → Promise.<Object>

List all content types accessible to this user.

Returns: Available content types
Examples
async ContentTypes();


{
  "iq__3tCKL1zJ2a2XqG5xktRDCoEMzVZv": {
    "id": "iq__3tCKL1zJ2a2XqG5xktRDCoEMzVZv",
    "hash": "hq__J39WocoEB1hc19t3o1YUaZM2PAzhRvLck6NVmFFviSTRM5yvVTcJ4SJeULw3VarH6mD6xkfjaC",
    "name": "ABR Master",
    "meta": {
      "public": {
        "description": "",
        "eluv.displayApp": "default",
        "eluv.manageApp": "default",
        "name": "ABR Master"
      }
    }
  },
  "iq__fTEG7r9sPawZpWqmyNxGMbdm5WR": {
    "id": "iq__fTEG7r9sPawZpWqmyNxGMbdm5WR",
    "hash": "hq__3MVUz8NbMXRUqR6LjUKzGgM1H43ZXWzPFYNp32Qs9f5Jb9QrFJXPX57qiXLUQdkQpJgb9yhwSR",
    "name": "AVLive",
    "meta": {
      "public": {
        "description": "",
        "eluv.displayApp": "default",
        "eluv.manageApp": "manageApp/index.html",
        "name": "AVLive"
      }
    }
  },
  "iq__T3CydLkQyiCDz3MrAumhRW7uazH": {
    "id": "iq__T3CydLkQyiCDz3MrAumhRW7uazH",
    "hash": "hq__7ywcAZ5Ac9rSJGTMErYj47nQpVbcz6BWVrS7oFfEASiUL2BQRxnEHj2QCYCJvQS115Djk9Nsgy",
    "name": "Library",
    "meta": {
      "public": {
        "description": "",
        "name": "Library"
      }
    }
  },
  "iq__RCFsiwubUs5bqeCwohR2wv1P4Q5": {
    "id": "iq__RCFsiwubUs5bqeCwohR2wv1P4Q5",
    "hash": "hq__E1nPgLBeDKWd4S25fGmSMmxQE7DzRTfMuc6j85duh2AJityFYTx9sig2vVXjXEYsVRsgrKioSm",
    "name": "Channel",
    "meta": {
      "public": {
        "description": "",
        "eluv.displayApp": "displayApp/index.html",
        "eluv.manageApp": "manageApp/index.html",
        "name": "Channel"
      }
    }
  },
  "iq__wkpaYK5tZwEBHdNyjyhw5SxRnYy": {
    "id": "iq__wkpaYK5tZwEBHdNyjyhw5SxRnYy",
    "hash": "hq__AsSK6q2Jh8vetffArMHiyMhEgQD4fyni1g5PgeBSPcKERMJv5hbuyAd3aNQTaeJD9ounyKTUEu",
    "name": "Production Master",
    "meta": {
      "public": {
        "description": "",
        "name": "Production Master"
      }
    }
  },
  "iq__y8YShB4kZWb2vQq2tvHx7wg3TLy": {
    "id": "iq__y8YShB4kZWb2vQq2tvHx7wg3TLy",
    "hash": "hq__mFfQ45h5Z5p2oZ3TMG4UaEf3xoU1hZnyfQPeWNuhoiYehUZ4cGqWH2HXNf9frjroZCeZYutWZ",
    "name": "Linear Channel",
    "meta": {
      "public": {
        "description": "",
        "eluv.displayApp": "displayApp/index.html",
        "eluv.manageApp": "manageApp/index.html",
        "name": "Linear Channel"
      }
    }
  }
}
async ContentTypes();


{
  "iq__3tCKL1zJ2a2XqG5xktRDCoEMzVZv": {
    "id": "iq__3tCKL1zJ2a2XqG5xktRDCoEMzVZv",
    "hash": "hq__J39WocoEB1hc19t3o1YUaZM2PAzhRvLck6NVmFFviSTRM5yvVTcJ4SJeULw3VarH6mD6xkfjaC",
    "name": "ABR Master",
    "meta": {
      "public": {
        "description": "",
        "eluv.displayApp": "default",
        "eluv.manageApp": "default",
        "name": "ABR Master"
      }
    }
  },
  "iq__fTEG7r9sPawZpWqmyNxGMbdm5WR": {
    "id": "iq__fTEG7r9sPawZpWqmyNxGMbdm5WR",
    "hash": "hq__3MVUz8NbMXRUqR6LjUKzGgM1H43ZXWzPFYNp32Qs9f5Jb9QrFJXPX57qiXLUQdkQpJgb9yhwSR",
    "name": "AVLive",
    "meta": {
      "public": {
        "description": "",
        "eluv.displayApp": "default",
        "eluv.manageApp": "manageApp/index.html",
        "name": "AVLive"
      }
    }
  },
  "iq__T3CydLkQyiCDz3MrAumhRW7uazH": {
    "id": "iq__T3CydLkQyiCDz3MrAumhRW7uazH",
    "hash": "hq__7ywcAZ5Ac9rSJGTMErYj47nQpVbcz6BWVrS7oFfEASiUL2BQRxnEHj2QCYCJvQS115Djk9Nsgy",
    "name": "Library",
    "meta": {
      "public": {
        "description": "",
        "name": "Library"
      }
    }
  },
  "iq__RCFsiwubUs5bqeCwohR2wv1P4Q5": {
    "id": "iq__RCFsiwubUs5bqeCwohR2wv1P4Q5",
    "hash": "hq__E1nPgLBeDKWd4S25fGmSMmxQE7DzRTfMuc6j85duh2AJityFYTx9sig2vVXjXEYsVRsgrKioSm",
    "name": "Channel",
    "meta": {
      "public": {
        "description": "",
        "eluv.displayApp": "displayApp/index.html",
        "eluv.manageApp": "manageApp/index.html",
        "name": "Channel"
      }
    }
  },
  "iq__wkpaYK5tZwEBHdNyjyhw5SxRnYy": {
    "id": "iq__wkpaYK5tZwEBHdNyjyhw5SxRnYy",
    "hash": "hq__AsSK6q2Jh8vetffArMHiyMhEgQD4fyni1g5PgeBSPcKERMJv5hbuyAd3aNQTaeJD9ounyKTUEu",
    "name": "Production Master",
    "meta": {
      "public": {
        "description": "",
        "name": "Production Master"
      }
    }
  },
  "iq__y8YShB4kZWb2vQq2tvHx7wg3TLy": {
    "id": "iq__y8YShB4kZWb2vQq2tvHx7wg3TLy",
    "hash": "hq__mFfQ45h5Z5p2oZ3TMG4UaEf3xoU1hZnyfQPeWNuhoiYehUZ4cGqWH2HXNf9frjroZCeZYutWZ",
    "name": "Linear Channel",
    "meta": {
      "public": {
        "description": "",
        "eluv.displayApp": "displayApp/index.html",
        "eluv.manageApp": "manageApp/index.html",
        "name": "Linear Channel"
      }
    }
  },
  "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4": {
    "id": "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4",
    "hash": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
    "name": "Test Content Type ccabade66b8fa5924627",
    "meta": {
      "public": {
        "name": "Test Content Type ccabade66b8fa5924627"
      }
    }
  }
}
Source:

static Decrypt({
libraryId,
objectId,
writeToken,
chunk
}) → Promise.<ArrayBuffer>

Decrypt the specified chunk for the specified object or draft

Parameters:
Name Type Description
libraryId string

ID of the library
objectId string

ID of the object
writeToken string

Write token of the content object draft
chunk ArrayBuffer | Buffer

The data to decrypt
Example
async Decrypt({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "chunk": "<ArrayBuffer 102657>"
});


<ArrayBuffer 100000>
Source:

static DefaultKMSAddress({tenantIdoptional}) → Promise.<string>

Get the address of the default KMS of the content space or the provided tenant

Returns: Address of the KMS
Parameters:
Name Type Attributes Description
tenantId string <optional>

An ID of a tenant contract - if not specified, the content space contract will be used
Example
async DefaultKMSAddress();


"0xff6Ac56821eEBb2C8e92cbdFd24fC93466AeAF9f"
Source:

static EmbedUrl({
objectId,
versionHash,
duration,
mediaTypeoptional,
options
}) → Promise.<string>

Get an embed URL for the specified object

Returns: Will return an embed URL
Parameters:
Name Type Attributes Default Description
objectId string

ID of the object
versionHash string

Version hash of the object
duration number

Time until the token expires, in milliseconds (1 day = 24 * 60 * 60 * 1000 = 86400000)
mediaType string <optional>
 video

The type of the media. Available options:

  • video
  • live_video
  • audio
  • image
  • gallery
  • ebook
  • html
options Object

Additional video/player options

  • autoplay - If enabled, video will autoplay. Note that videos block autoplay of videos with audio by default
  • capLevelToPlayerSize - Caps video quality to player size
  • clipEnd - End time for the video
  • clipStart - Start time for the video
  • controls - Sets the player control visibility. Values: browserDefault | autoHide | show | hide | hideWithVolume. Defaults to autoHide
  • description - Sets the page description
  • directLink - If enabled, sets direct link
  • linkPath - Video link path
  • loop - If enabled, video will loop
  • muted - Mutes the player
  • offerings - Offerings to play, as an array
  • posterUrl - URL of the player poster image
  • protocols - Video protocols, as an array
  • showShare - Show social media share buttons
  • showTitle - Shows the video title, which is set from the title option (if set) or the metadata
  • title - Sets the page title
  • viewRecordKey - Contains record key
  • useTicketCodes - Use tickets authorization
  • tenantId - Tenant ID, required for tickets authorization
  • ntpId - NTP ID, required for tickets authorization
  • ticketCode - Ticket code, optional with tickets authorization
  • ticketSubject - Ticket subject, optional with tickets authorization
Source:

static Encrypt({
libraryId,
objectId,
writeToken,
chunk
}) → Promise.<ArrayBuffer>

Encrypt the specified chunk for the specified object or draft

Parameters:
Name Type Description
libraryId string

ID of the library
objectId string

ID of the object
writeToken string

Write token of the content object draft
chunk ArrayBuffer | Buffer

The data to encrypt
Example
async Encrypt({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "chunk": "<ArrayBuffer 100000>"
});


<ArrayBuffer 102657>
Source:

static EncryptionConk({
libraryId,
objectId,
versionHash,
writeTokenoptional,
downloadoptional
})

Retrieve the encryption conk for the specified object. If one has not yet been created and a writeToken has been specified, this method will create a new conk and save it to the draft metadata

Returns:

Promise - The encryption conk for the object

Parameters:
Name Type Attributes Default Description
libraryId string

ID of the library
objectId string

ID of the object
versionHash string

Version hash of the object
writeToken string <optional>

Write token of the content object draft
download boolean <optional>
 false

If specified, will return keys appropriate for download (if the current user is not the owner of the object, download will be performed via proxy-reencryption)
Examples
async EncryptionConk({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


{
  "symm_key": "kpsyTtjPSEcwWGz5Ycp7utDTw",
  "secret_key": "kpsk11111111111111118TdnL1vXGeWcbCMxceC8GXjWFP7vLDb9FJpL6wzNrUCC",
  "public_key": "kppk77o3cYp1pXXJmMFN3hMh2n2ZUzfx49YyEUgqDykeFUjohphbPhK3XW5AwmDLoUVDAK4RYCrpSWbLbE7THo55wR7eFczupEcpLMe7S6RXgAV9pXdAraZHPyz81wxwAjp6Bw7S",
  "sid": "ispc4BRmonTig9QSD87MRWP8F5iLfdct",
  "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
}
async EncryptionConk({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "download": true
});


{
  "symm_key": "kpsyTtjPSEcwWGz5Ycp7utDTw",
  "secret_key": "kpsk11111111111111118TdnL1vXGeWcbCMxceC8GXjWFP7vLDb9FJpL6wzNrUCC",
  "public_key": "kppk77o3cYp1pXXJmMFN3hMh2n2ZUzfx49YyEUgqDykeFUjohphbPhK3XW5AwmDLoUVDAK4RYCrpSWbLbE7THo55wR7eFczupEcpLMe7S6RXgAV9pXdAraZHPyz81wxwAjp6Bw7S",
  "sid": "ispc4BRmonTig9QSD87MRWP8F5iLfdct",
  "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
}
async EncryptionConk({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "writeToken": "tqw__HSWgNH437Rr4NGVUdmRuWp9fZceiqnsHECxy4Z2RAfTzinnEYjVkCn2sAB1d7GyZGWJb8zwVn8YrDiKsgEt"
});


{
  "symm_key": "kpsyTtjPSEcwWGz5Ycp7utDTw",
  "secret_key": "kpsk11111111111111118TdnL1vXGeWcbCMxceC8GXjWFP7vLDb9FJpL6wzNrUCC",
  "public_key": "kppk77o3cYp1pXXJmMFN3hMh2n2ZUzfx49YyEUgqDykeFUjohphbPhK3XW5AwmDLoUVDAK4RYCrpSWbLbE7THo55wR7eFczupEcpLMe7S6RXgAV9pXdAraZHPyz81wxwAjp6Bw7S",
  "sid": "ispc4BRmonTig9QSD87MRWP8F5iLfdct",
  "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
}
async EncryptionConk({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "writeToken": "tqw__HSWgNH437Rr4NGVUdmRuWp9fZceiqnsHECxy4Z2RAfTzinnEYjVkCn2sAB1d7KfSgfRdd1GdJC6vX6i4VSV"
});


{
  "symm_key": "kpsyTtjPSEcwWGz5Ycp7utDTw",
  "secret_key": "kpsk11111111111111118TdnL1vXGeWcbCMxceC8GXjWFP7vLDb9FJpL6wzNrUCC",
  "public_key": "kppk77o3cYp1pXXJmMFN3hMh2n2ZUzfx49YyEUgqDykeFUjohphbPhK3XW5AwmDLoUVDAK4RYCrpSWbLbE7THo55wR7eFczupEcpLMe7S6RXgAV9pXdAraZHPyz81wxwAjp6Bw7S",
  "sid": "ispc4BRmonTig9QSD87MRWP8F5iLfdct",
  "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
}
async EncryptionConk({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "writeToken": "tqw__HSWgNH437Rr4NGVUdmRuWp9fZceiqnsHECxy4Z2RAfTzinnEYjVkCn2sAB1d7WGT2ygMgjMdgASLBW5yxDT"
});


{
  "symm_key": "kpsyTtjPSEcwWGz5Ycp7utDTw",
  "secret_key": "kpsk11111111111111118TdnL1vXGeWcbCMxceC8GXjWFP7vLDb9FJpL6wzNrUCC",
  "public_key": "kppk77o3cYp1pXXJmMFN3hMh2n2ZUzfx49YyEUgqDykeFUjohphbPhK3XW5AwmDLoUVDAK4RYCrpSWbLbE7THo55wR7eFczupEcpLMe7S6RXgAV9pXdAraZHPyz81wxwAjp6Bw7S",
  "sid": "ispc4BRmonTig9QSD87MRWP8F5iLfdct",
  "qid": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
}
Source:

static FabricUrl({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional,
partHashoptional,
repoptional,
publicRepoptional,
calloptional,
queryParamsoptional,
serviceoptional,
channelAuthoptional,
noAuthoptional,
noCacheoptional,
makeAccessRequestoptional
}) → Promise.<string>

Generate a URL to the specified item in the content fabric with appropriate authorization token.

Returns: URL to the specified endpoint with authorization token
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of an library
objectId string <optional>

ID of an object
versionHash string <optional>

Hash of an object version
writeToken string <optional>

A write token for a draft of the object (requires libraryId)
partHash string <optional>

Hash of a part - Requires object ID
rep string <optional>

Rep parameter of the url
publicRep string <optional>

Public rep parameter of the url
call string <optional>

Bitcode method to call
queryParams Object <optional>

Query params to add to the URL
service string <optional>
 fabric

The service to use. By default, will use a fabric node. Options: "fabric", "search", "auth"
channelAuth boolean <optional>
 false

If specified, state channel authorization will be used instead of access request authorization
noAuth boolean <optional>
 false

If specified, authorization will not be performed and the URL will not have an authorization token. This is useful for accessing public assets.
noCache boolean <optional>
 false

If specified, a new access request will be made for the authorization regardless of whether such a request exists in the client cache. This request will not be cached. This option has no effect if noAuth is true.
makeAccessRequest boolean <optional>
 false

If using auth, will make a full access request
Examples
async FabricUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4ODBlMWZiMGM2ZGY1ZTZiMjg0N2E2OTAzYjcyYTMzMTU1N2Q0ODU5MWUzY2E0MWY5MTI2NDhkOWRiZTVjODE4MSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0dKRXFNVmlkZUtnUTRGQWVMemU2TVBuN0FrdzRDV2VkUWZ1SjhOcHR5S0c4bXBLUFdTUGtSY1BtZWI4anpMakdwb2tIYWNNVlpiM3liQW5xcUx6ZHNEelhE"
async FabricUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0R4MXpWNVM1bkRtREdpRXdIU3ZxdTFpaWQzeTdBc01CeUpESEpielphdXZINVdXSmh0Nkc4MTJpNzNITVdHem41V1padzRhSkJkcUsyOU15QTR2UTVKYlFQ"
async FabricUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0R4MXpWNVM1bkRtREdpRXdIU3ZxdTFpaWQzeTdBc01CeUpESEpielphdXZINVdXSmh0Nkc4MTJpNzNITVdHem41V1padzRhSkJkcUsyOU15QTR2UTVKYlFQ"
async FabricUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "partHash": "hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/data/hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0R4MXpWNVM1bkRtREdpRXdIU3ZxdTFpaWQzeTdBc01CeUpESEpielphdXZINVdXSmh0Nkc4MTJpNzNITVdHem41V1padzRhSkJkcUsyOU15QTR2UTVKYlFQ"
async FabricUrl({
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "partHash": "hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR"
});


"https://host-34-105-49-255.testv2.contentfabric.io/q/hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF/data/hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSJ9.RVMyNTZLX0dLVHYzcmlaTmtvSnl6QUg1RmhFeFc5U040ak1mVG54eG5NM0F0NEFYcVEzMWUyNzlBdWpvZHVNZkhuWWp5aVNDM2VMUnZISGVXVURwWndLUVVQVGp5SkVl"
async FabricUrl({
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "call": "method"
});


"https://host-34-105-49-255.testv2.contentfabric.io/q/hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF/call/method?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSJ9.RVMyNTZLX0dLVHYzcmlaTmtvSnl6QUg1RmhFeFc5U040ak1mVG54eG5NM0F0NEFYcVEzMWUyNzlBdWpvZHVNZkhuWWp5aVNDM2VMUnZISGVXVURwWndLUVVQVGp5SkVl"
async FabricUrl({
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "rep": "image"
});


"https://host-34-105-49-255.testv2.contentfabric.io/q/hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF/rep/image?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSJ9.RVMyNTZLX0dLVHYzcmlaTmtvSnl6QUg1RmhFeFc5U040ak1mVG54eG5NM0F0NEFYcVEzMWUyNzlBdWpvZHVNZkhuWWp5aVNDM2VMUnZISGVXVURwWndLUVVQVGp5SkVl"
async FabricUrl({
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "partHash": "hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR"
});


"https://host-34-105-49-255.testv2.contentfabric.io/q/hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF/data/hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSJ9.RVMyNTZLX0dLVHYzcmlaTmtvSnl6QUg1RmhFeFc5U040ak1mVG54eG5NM0F0NEFYcVEzMWUyNzlBdWpvZHVNZkhuWWp5aVNDM2VMUnZISGVXVURwWndLUVVQVGp5SkVl"
async FabricUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "queryParams": {
    "param1": "value1",
    "param2": "value2",
    "param3": "value3"
  }
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs?param1=value1&param2=value2&param3=value3&authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0R4MXpWNVM1bkRtREdpRXdIU3ZxdTFpaWQzeTdBc01CeUpESEpielphdXZINVdXSmh0Nkc4MTJpNzNITVdHem41V1padzRhSkJkcUsyOU15QTR2UTVKYlFQ"
async FabricUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "noAuth": true
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw"
async FabricUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "rep": "image",
  "queryParams": {},
  "channelAuth": false,
  "noAuth": false,
  "noCache": false
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD/rep/image?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0R4MXpWNVM1bkRtREdpRXdIU3ZxdTFpaWQzeTdBc01CeUpESEpielphdXZINVdXSmh0Nkc4MTJpNzNITVdHem41V1padzRhSkJkcUsyOU15QTR2UTVKYlFQ"
async FabricUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "rep": "image",
  "queryParams": {},
  "channelAuth": false,
  "noAuth": true,
  "noCache": false
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD/rep/image?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw"
Source:

static FileUrl({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional,
filePath,
queryParamsoptional,
noCacheoptional
}) → Promise.<string>

Generate a URL to the specified content object file with appropriate authorization token.

Returns: URL to the specified file with authorization token
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of an library
objectId string <optional>

ID of an object
versionHash string <optional>

Hash of an object version
writeToken string <optional>

A write token for a draft of the object (requires libraryId)
filePath string

Path to the content object file
queryParams Object <optional>

Query params to add to the URL
noCache boolean <optional>
 false

If specified, a new access request will be made for the authorization regardless of whether such a request exists in the client cache. This request will not be cached.
Examples
async FileUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "filePath": "file"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/files/file?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0R4MXpWNVM1bkRtREdpRXdIU3ZxdTFpaWQzeTdBc01CeUpESEpielphdXZINVdXSmh0Nkc4MTJpNzNITVdHem41V1padzRhSkJkcUsyOU15QTR2UTVKYlFQ"
async FileUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "filePath": "dir/file"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/files/dir/file?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0R4MXpWNVM1bkRtREdpRXdIU3ZxdTFpaWQzeTdBc01CeUpESEpielphdXZINVdXSmh0Nkc4MTJpNzNITVdHem41V1padzRhSkJkcUsyOU15QTR2UTVKYlFQ"
async FileUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "filePath": "file",
  "queryParams": {
    "param1": "value1",
    "param2": "value2",
    "param3": "value3"
  }
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/files/file?param1=value1&param2=value2&param3=value3&authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0R4MXpWNVM1bkRtREdpRXdIU3ZxdTFpaWQzeTdBc01CeUpESEpielphdXZINVdXSmh0Nkc4MTJpNzNITVdHem41V1padzRhSkJkcUsyOU15QTR2UTVKYlFQ"
async FileUrl({
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "versionHash": "hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF",
  "filePath": "file"
});


"https://host-34-105-49-255.testv2.contentfabric.io/q/hq__2hRfGeY9TRxCQPK6jUgpkBCGyxsyRx4kx35Q32u7XUMkzS7v6ThjgoTX7WY6SwNYdANsUW7MwF/files/file?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSJ9.RVMyNTZLX0dLVHYzcmlaTmtvSnl6QUg1RmhFeFc5U040ak1mVG54eG5NM0F0NEFYcVEzMWUyNzlBdWpvZHVNZkhuWWp5aVNDM2VMUnZISGVXVURwWndLUVVQVGp5SkVl"
Source:

static FinalizeStateChannelAccess({
objectIdoptional,
versionHashoptional,
percentComplete
})

Finalize state channel access

Parameters:
Name Type Attributes Description
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object
percentComplete number

Completion percentage of the content
Example
async FinalizeStateChannelAccess({
  "objectId": "iq__yZ7kzRmc1wVABhgJHPRysLaKQWe",
  "percentComplete": 100
});


<No Return Value>
Source:

static GenerateStateChannelToken({
objectIdoptional,
versionHashoptional,
contextoptional,
noCacheoptional
}) → Promise.<string>

Generate a state channel token.

Returns: The state channel token
Parameters:
Name Type Attributes Default Description
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object
context Object <optional>

Additional audience data to include in the authorization request

  • Note: Context must be a map of string->string
noCache boolean <optional>
 false

If specified, a new state channel token will be generated regardless whether or not one has been previously cached
Example
async GenerateStateChannelToken({
  "objectId": "iq__yZ7kzRmc1wVABhgJHPRysLaKQWe"
});


"eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsInFsaWJfaWQiOiJpbGliM05XWW1mVDNKWlpGVGN2NEFteTFhdGhmZHVEeCIsImFkZHIiOiIweEQ0M2UwMDYzNUYwODE2NTgwOTUwMkQ5MjlmZWNCNjgyMjgyY2NjNWMiLCJxaWQiOiJpcV9feVo3a3pSbWMxd1ZBQmhnSkhQUnlzTGFLUVdlIiwiZ3JhbnQiOiJyZWFkIiwidHhfcmVxdWlyZWQiOmZhbHNlLCJpYXQiOjE1OTY5MjI3OTAsImV4cCI6MTU5NzAwOTE5MSwiYXV0aF9zaWciOiJFUzI1NktfRHlvNnI0czgyakVURG9hZ0FISFVUY29qY1V3R20xS0M4ZDExTmdZR3JLdmhVUzFmSGk1TkZYRWVxb212RExlVXBWTWZWWDJCeWVaUFJ6d1FuWjZUSjVaMlEiLCJhZmdoX3BrIjoiIn0=.RVMyNTZLXzg5d2dOSGN1WXBlTG9GRDl4ZHZQSjZHTWdpUXRGMVJ1eEVDd05xd0RkMmhtSFRmZ2t1bmhIcDYxWlBhU1B1WHJqU01yaFhhaWRWU205ZVB4dUR4OFZtRlpk"
Source:

static GlobalUrl({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional,
pathoptional,
authorizationTokenoptional,
noAuthoptional,
resolveoptional,
queryParamsoptional
}) → Promise.<string>

Create a 'global' URL with the specified parameters

A global URL is a URL that will resolve to a Fabric node close to the resolver. This is useful in cases where URLS are being passed to clients that may be in a different geographical location from where the URL was created.

Returns: The generated global URL
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object
writeToken string <optional>

Write token of an object draft
path string <optional>

Path of the URL
authorizationToken string <optional>

Authorization token for the URL. If not specified and noAuth is false, the client will generate the token automatically
noAuth boolean <optional>
 false

Set to true if the URL is for publicly accessible content
resolve boolean <optional>
 false

Whether links should resolve (if this URL is for metadata)
queryParams Object <optional>
 {}

Additional URL query params
Source:

static LatestVersionHash({
objectIdoptional,
versionHashoptional
}) → Promise.<string>

Retrieve the version hash of the latest version of the specified object from chain

Returns: The latest version hash of the object
Parameters:
Name Type Attributes Description
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object
Examples
async LatestVersionHash({
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy"
});


"hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3"
async LatestVersionHash({
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy"
});


"hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs"
async LatestVersionHash({
  "objectId": "iq__3MvjYsa9bi4aywAYAXUhrvsQVHZq"
});


"hq__HX8rWEhiUP1koNyZvhw7ijtzpvk3Ysp7ZHuFb47Cp7vRD5GPcYxSDdAVPeXFXEyjGLHzLWXsps"
async LatestVersionHash({
  "objectId": "iq__24DVjj4gbe8TwRguc9f2bqXFL2Dh"
});


"hq__KEb1KzuifJmqr6wVFDFLwMJjLNb3YJxCyNGgN9U7TiviEVPMQ2ZLZA5eknQ1rey7tvWYqsCedh"
async LatestVersionHash({
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


"hq__5u5T6cb8qSAE5ms7hQF6FMcmPmDTeyZHu1Zz5rFjLCHnzeVrFMt993cDcstkW4k5AqrrRN91sP"
async LatestVersionHash({
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs"
});


"hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD"
Source:

static LatestVersionHashV2({
objectIdoptional,
versionHashoptional
}) → Promise.<string>

Retrieve the version hash of the latest version of the specified object via fabric API. Requires authorization.

Returns: The latest version hash of the object
Parameters:
Name Type Attributes Description
objectId string <optional>

ID of the object
versionHash string <optional>

Version hash of the object
Source:

static LibraryContentTypes({libraryId}) → Promise.<Object>

Retrieve the allowed content types for the specified library.

Note: If no content types have been set on the library, all types are allowed, but an empty hash will be returned.

Returns: List of accepted content types - return format is equivalent to ContentTypes method
See:
Parameters:
Name Type Description
libraryId string

ID of the library
Examples
async LibraryContentTypes({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
});


{}
async LibraryContentTypes({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2"
});


{
  "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4": {
    "id": "iq__3ZeNik5xdThEuYsEaGj8fAE7Kcv4",
    "hash": "hq__LVJqN7DWzCeZSQRvjxTaSGSpnpDbec1uMwDhAgaaKEPT8cydYYwBgA19foTuw3e2EYTzGe5fW8",
    "name": "Test Content Type ccabade66b8fa5924627",
    "meta": {
      "bitcode_part": "hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR",
      "commit": {
        "author": "0x665aee2328fa4040e569e91be23faf5a82a6186c",
        "author_address": "0x665aee2328fa4040e569e91be23faf5a82a6186c",
        "message": "Create content type",
        "timestamp": "2021-03-09T20:00:47.030Z"
      },
      "name": "Test Content Type ccabade66b8fa5924627",
      "public": {
        "name": "Test Content Type ccabade66b8fa5924627"
      }
    }
  }
}
Source:

static LinkData({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional,
linkPath,
queryParamsoptional,
formatoptional,
channelAuthoptional
})

Retrieve the data at the specified link in the specified format

Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of an library
objectId string <optional>

ID of an object
versionHash string <optional>

Hash of an object version
writeToken string <optional>

The write token for the object
linkPath string

Path to the content object link
queryParams Object <optional>

Query params to add to the URL
format string <optional>
 json

Format of the response
channelAuth boolean <optional>
 false

If specified, state channel authorization will be performed instead of access request authorization
Examples
async LinkData({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "myLink",
  "format": "arrayBuffer"
});


<ArrayBuffer 100000>
async LinkData({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "links/myLink2",
  "format": "arrayBuffer"
});


<ArrayBuffer 100000>
async LinkData({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "links/metadataLink",
  "format": "json"
});


{
  "data": {
    "to": "show"
  },
  "some": "meta"
}
Source:

static LinkTarget({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional,
linkPath,
authorizationTokenoptional
}) → Promise.<string>

Retrieve the version hash of the target of the specified link. If the target is the same as the specified object and versionHash is not specified, will return the latest version hash.

Returns: Version hash of the link's target
Parameters:
Name Type Attributes Description
libraryId string <optional>

ID of an library
objectId string <optional>

ID of an object
versionHash string <optional>

Hash of an object version
writeToken string <optional>

The write token for the object
linkPath string

Path to the content object link
authorizationToken string <optional>

Additional authorization token for this request
Examples
async LinkTarget({
  "libraryId": "ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV",
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy",
  "versionHash": "hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3",
  "linkPath": "public/asset_metadata/sources/default",
  "linkInfo": {
    ".": {
      "container": "hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3"
    },
    "/": "./rep/playout/default/options.json"
  }
});


"hq__AXQrQWT8v1Xe784ciwaFJoXphaeoXHJzsG3JY8NHTsXZcZ18jqx6dPfqT8268c8Aoq5VnsmC3"
async LinkTarget({
  "libraryId": "ilib3JgZBNxZE8ZkM4jP8YUAdTnjukWV",
  "objectId": "iq__4Ym91uVyPhayTRsew3ixQ8aGDJjy",
  "versionHash": "hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs",
  "linkPath": "public/videoLink/default",
  "linkInfo": {
    ".": {
      "container": "hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs"
    },
    "/": "./rep/playout/default/options.json"
  }
});


"hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs"
async LinkTarget({
  "libraryId": "ilib2wXUwatNUvPoBWtNyiyDEsEYRxX3",
  "objectId": "iq__3MvjYsa9bi4aywAYAXUhrvsQVHZq",
  "versionHash": "hq__HX8rWEhiUP1koNyZvhw7ijtzpvk3Ysp7ZHuFb47Cp7vRD5GPcYxSDdAVPeXFXEyjGLHzLWXsps",
  "linkPath": "public/videoLink",
  "linkInfo": {
    ".": {
      "container": "hq__HX8rWEhiUP1koNyZvhw7ijtzpvk3Ysp7ZHuFb47Cp7vRD5GPcYxSDdAVPeXFXEyjGLHzLWXsps"
    },
    "/": "/qfab/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout/default/options.json"
  }
});


"hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs"
async LinkTarget({
  "libraryId": "ilib2wXUwatNUvPoBWtNyiyDEsEYRxX3",
  "objectId": "iq__3MvjYsa9bi4aywAYAXUhrvsQVHZq",
  "versionHash": "hq__HX8rWEhiUP1koNyZvhw7ijtzpvk3Ysp7ZHuFb47Cp7vRD5GPcYxSDdAVPeXFXEyjGLHzLWXsps",
  "linkPath": "public/multiOfferingVideoLink",
  "linkInfo": {
    ".": {
      "container": "hq__HX8rWEhiUP1koNyZvhw7ijtzpvk3Ysp7ZHuFb47Cp7vRD5GPcYxSDdAVPeXFXEyjGLHzLWXsps"
    },
    "/": "/qfab/hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs/rep/playout"
  }
});


"hq__CPA8kvgi3XgZW6wUWv1F1GZCjnBuRjtx3YaepZqwyCVZXKHDyKsv4ncddX3BGvFXynZzQiU3cs"
Source:

static LinkUrl({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional,
linkPath,
mimeTypeoptional,
queryParamsoptional,
authorizationTokenoptional,
channelAuthoptional,
noAuthoptional
}) → Promise.<string>

Generate a URL to the specified file link with appropriate authentication

Returns: URL to the specified file with authorization token
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of an library
objectId string <optional>

ID of an object
versionHash string <optional>

Hash of an object version
writeToken string <optional>

The write token for the object
linkPath string

Path to the content object link
mimeType string <optional>

Mime type to use when rendering the file
queryParams Object <optional>

Query params to add to the URL
authorizationToken string <optional>

Additional authorization token
channelAuth boolean <optional>
 false

If specified, state channel authorization will be performed instead of access request authorization
noAuth boolean <optional>

If specified, no authorization (other than the authorizationToken parameter and queryParams.authorization) will be added
Examples
async LinkUrl({
  "versionHash": "hq__M2cRBoY54E8erCzTj5HZUD8FzAgEPGU5Y2N7yQq6Lrgp35bQEshLZstSAQtJKMjWpwNLjAAc9L",
  "linkPath": "public/display_image",
  "queryParams": {}
});


"https://host-34-105-49-255.testv2.contentfabric.io/q/hq__M2cRBoY54E8erCzTj5HZUD8FzAgEPGU5Y2N7yQq6Lrgp35bQEshLZstSAQtJKMjWpwNLjAAc9L/meta/public/display_image?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4ODBlMWZiMGM2ZGY1ZTZiMjg0N2E2OTAzYjcyYTMzMTU1N2Q0ODU5MWUzY2E0MWY5MTI2NDhkOWRiZTVjODE4MSJ9.RVMyNTZLX056azNaUVRGWEVIUEFRZWNibnpUam5iM2h5SmQycWR1eEsyWWp6VmVCU2Y5ekU3b1hpbkNOV0JOS1FTdWJLaXNuMW5aY29qMk1YSmoxRFdKQ0o2YjdEeVhw&resolve=true"
async LinkUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "myLink",
  "mimeType": "application/octet-stream"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/meta/myLink?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw&resolve=true&header-accept=application%2Foctet-stream"
async LinkUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "links/myLink2",
  "mimeType": "image/*"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/meta/links/myLink2?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw&resolve=true&header-accept=image%2F%2A"
async LinkUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "myLink",
  "queryParams": {}
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/meta/myLink?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw&resolve=true"
async LinkUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "links/myLink2",
  "queryParams": {}
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/meta/links/myLink2?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw&resolve=true"
async LinkUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "links/metadataLink",
  "queryParams": {}
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/meta/links/metadataLink?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw&resolve=true"
async LinkUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "/links/myLink2"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/meta/links/myLink2?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw&resolve=true"
async LinkUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "/myLink"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/meta/myLink?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw&resolve=true"
async LinkUrl({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "linkPath": "links/myLink2"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs/meta/links/myLink2?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw&resolve=true"
Source:

static Permission(
objectId,
clearCacheoptional
) → string

Get the current permission level for the specified object. See client.permissionLevels for all available permissions.

Note: This method is only intended for normal content objects, not types, libraries, etc.

Returns: Key for the permission of the object - Use this to retrieve more details from client.permissionLevels
Parameters:
Name Type Attributes Description
objectId string

The ID of the object
clearCache boolean <optional>

Clear any Visibility info cached by client for this object (forces new Ethereum calls)
Source:

static PlayoutOptions({
offeringURIoptional,
objectIdoptional,
versionHashoptional,
writeTokenoptional,
linkPathoptional,
signedLinkoptional,
protocols,
drms,
handleroptional,
offeringoptional,
playoutTypeoptional,
contextoptional,
authorizationTokenoptional,
optionsoptional
})

Retrieve playout options for the specified content that satisfy the given protocol and DRM requirements

The root level playoutOptions[protocol].playoutUrl and playoutOptions[protocol].drms will contain playout information that satisfies the specified DRM requirements (if possible), while playoutOptions[protocol].playoutMethods will contain all available playout options for this content.

If only objectId is specified, latest version will be played. To retrieve playout options for a specific version of the content, provide the versionHash parameter (in which case objectId is unnecessary)

Parameters:
Name Type Attributes Default Description
offeringURI string <optional>

A URI pointing directly to the playout options endpoint
objectId string <optional>

ID of the content
versionHash string <optional>

Version hash of the content
writeToken string <optional>

Write token for the content
linkPath string <optional>

If playing from a link, the path to the link
signedLink boolean <optional>

Specify if linkPath is referring to a signed link
protocols Array.<string> ["dash","hls"]

Acceptable playout protocols ("dash", "hls")
drms Array.<string>

Acceptable DRM formats ("aes-128", "clear", "fairplay", "playready", "sample-aes", "widevine")
handler string <optional>
 playout

The handler to use for playout (not used with links)
offering string <optional>
 default

The offering to play
playoutType string <optional>

The type of playout
context Object <optional>

Additional audience data to include in the authorization request.

  • Note: Context must be a map of string->string
authorizationToken Object <optional>

Additional authorization token for authorizing this request
options Object <optional>

Additional query parameters to pass when requesting available playout options, such as clipping parameters.
Example
await client.PlayoutOptions({
  versionHash: "hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo"
})


{
  "dash": {
    "playoutMethods": {
      "clear": {
        "playoutUrl": "https://host-76-74-91-7.contentfabric.io/qlibs/ilib3C82jGbT41QLSZb35dDwmUWbSuP9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/dash-clear/dash.mpd?authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&resolve=false&sid=30968DB75C1A",
        "globalPlayoutUrl": "https://main.net955305.contentfabric.io/t/eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/dash-clear/dash.mpd?resolve=false&authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&sid=30968DB75C1A"
      },
      "widevine": {
        "playoutUrl": "https://host-76-74-91-7.contentfabric.io/qlibs/ilib3C82jGbT41QLSZb35dDwmUWbSuP9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/dash-widevine/dash.mpd?authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&resolve=false&sid=30968DB75C1A",
        "globalPlayoutUrl": "https://main.net955305.contentfabric.io/t/eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/dash-widevine/dash.mpd?resolve=false&authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&sid=30968DB75C1A",
        "drms": {
          "widevine": {
            "licenseServers": [
              "https://host-76-74-28-232.contentfabric.io/ks/wv/?authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&qhash=hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo&resolve=false",
              "https://host-76-74-29-8.contentfabric.io/ks/wv/?authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&qhash=hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo&resolve=false",
              "https://host-154-14-211-98.contentfabric.io/ks/wv/?authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&qhash=hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo&resolve=false"
            ]
          }
        }
      }
    },
    "playoutUrl": "https://host-76-74-91-7.contentfabric.io/qlibs/ilib3C82jGbT41QLSZb35dDwmUWbSuP9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/dash-clear/dash.mpd?authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&resolve=false&sid=30968DB75C1A"
  },
  "hls": {
    "playoutMethods": {
      "aes-128": {
        "playoutUrl": "https://host-76-74-91-7.contentfabric.io/qlibs/ilib3C82jGbT41QLSZb35dDwmUWbSuP9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/hls-aes128/playlist.m3u8?authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&resolve=false&sid=30968DB75C1A&player_profile=hls-js",
        "globalPlayoutUrl": "https://main.net955305.contentfabric.io/t/eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/hls-aes128/playlist.m3u8?resolve=false&authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&sid=30968DB75C1A&player_profile=hls-js",
        "drms": {
          "aes-128": {}
        }
      },
      "clear": {
        "playoutUrl": "https://host-76-74-91-7.contentfabric.io/qlibs/ilib3C82jGbT41QLSZb35dDwmUWbSuP9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/hls-clear/playlist.m3u8?authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&resolve=false&sid=30968DB75C1A&player_profile=hls-js",
        "globalPlayoutUrl": "https://main.net955305.contentfabric.io/t/eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/hls-clear/playlist.m3u8?resolve=false&authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&sid=30968DB75C1A&player_profile=hls-js"
      }
    },
    "playoutUrl": "https://host-76-74-91-7.contentfabric.io/qlibs/ilib3C82jGbT41QLSZb35dDwmUWbSuP9/q/hq__CcdV4wnCNq9wv6jXpYeCQ2GE4FLQBFtVSSSt2XKfBJMrH89DFDGsfkpWWvBy16QBGGYeF5mLGo/rep/playout/default/hls-clear/playlist.m3u8?authorization=eyJxc3BhY2VfaWQiOiJpc3BjMlJVb1JlOWVSMnYzM0hBUlFVVlNwMXJZWHp3MSJ9&resolve=false&sid=30968DB75C1A&player_profile=hls-js"
  }
}
Source:

static Proofs({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
partHash
}) → Promise.<Object>

Get the proofs associated with a given part

Returns: Response containing proof information
Parameters:
Name Type Attributes Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Hash of the object version - If not specified, latest version will be used
partHash string

Hash of the part
Example
async Proofs({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "partHash": "hqp_R3rrwwWjBqFTzW4FbcDni1fmRZNtp6basgRReMau3HLVZTpR"
});


{
  "root_hash": "cbaa8f55efa6d0af4f1fec811f909e061555cfbb63bb3cee5ccd6115f42d2084",
  "proofs": [
    {
      "byte_beg": 0,
      "byte_end": 99999,
      "proof": [
        "cbaa8f55efa6d0af4f1fec811f909e061555cfbb63bb3cee5ccd6115f42d2084"
      ]
    }
  ],
  "proof_data": {
    "cbaa8f55efa6d0af4f1fec811f909e061555cfbb63bb3cee5ccd6115f42d2084": "+FyhIPEGBJh9T7TDuHobdRSzTMz3Vh9Hf18KMQDLZhBbR7F4uDgAAAAAAAAAAAAAAAAAAAAAn4YBAAAAAADxBgSYfU+0w7h6G3UUs0zM91YfR39fCjEAy2YQW0exeA=="
  }
}
Source:

static PublicRep({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
rep,
queryParamsoptional
}) → Promise.<string>

Generate a URL to the specified /public endpoint of a content object. URL includes authorization token.

Alias for the FabricUrl method with the "rep" parameter

Returns: URL to the specified rep endpoint with authorization token
See:
  • FabricUrl for creating arbitrary fabric URLs
Parameters:
Name Type Attributes Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Hash of the object version - if not specified, latest version will be used
rep string

Representation to use
queryParams Object <optional>

Query params to add to the URL
Source:

static QParts({
libraryId,
objectId,
partHash,
format
}) → Promise.<Format>

Get part info in CBOR format

Returns: Response containing the CBOR response in the specified format
Parameters:
Name Type Description
libraryId string

ID of the library - required for authentication
objectId string

ID of the object - required for authentication
partHash string

Hash of the part
format string

Format to retrieve the response - defaults to Blob
Source:

static Rep({
libraryIdoptional,
objectIdoptional,
versionHashoptional,
rep,
queryParamsoptional,
serviceoptional,
channelAuthoptional,
noAuthoptional,
noCacheoptional,
makeAccessRequestoptional
}) → Promise.<string>

Generate a URL to the specified /rep endpoint of a content object. URL includes authorization token.

Alias for the FabricUrl method with the "rep" parameter

Returns: URL to the specified rep endpoint with authorization token
See:
  • FabricUrl for creating arbitrary fabric URLs
Parameters:
Name Type Attributes Default Description
libraryId string <optional>

ID of the library
objectId string <optional>

ID of the object
versionHash string <optional>

Hash of the object version - if not specified, latest version will be used
rep string

Representation to use
queryParams Object <optional>

Query params to add to the URL
service string <optional>
 fabric

The service to use. By default, will use a fabric node. Options: "fabric", "search", "auth"
channelAuth boolean <optional>
 false

If specified, state channel authorization will be performed instead of access request authorization
noAuth boolean <optional>
 false

If specified, authorization will not be performed and the URL will not have an authorization token. This is useful for accessing public assets.
noCache boolean <optional>
 false

If specified, a new access request will be made for the authorization regardless of whether such a request exists in the client cache. This request will not be cached. This option has no effect if noAuth is true.
makeAccessRequest boolean <optional>
 false

If using auth, will make a full access request
Examples
async Rep({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "rep": "image"
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD/rep/image?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJ0eF9pZCI6IjB4N2Y2NTEyMmMwYzgxZGQ4M2RmYzFiZmQ4ZGYwNGZiY2Q3Y2ViYjlmNTZkYzYyMzBmOGNlNmI1NzczZmQ4MjIxOSIsInFsaWJfaWQiOiJpbGliMzc2MnZlb3NrSFF0QXdvVVpaUlgyNlYycUtjMiJ9.RVMyNTZLX0R4MXpWNVM1bkRtREdpRXdIU3ZxdTFpaWQzeTdBc01CeUpESEpielphdXZINVdXSmh0Nkc4MTJpNzNITVdHem41V1padzRhSkJkcUsyOU15QTR2UTVKYlFQ"
async Rep({
  "libraryId": "ilib3762veoskHQtAwoUZZRX26V2qKc2",
  "objectId": "iq__3MXtFtRdbFtPwKHmw46mgmd8GQjs",
  "rep": "image",
  "noAuth": true
});


"https://host-34-105-49-255.testv2.contentfabric.io/qlibs/ilib3762veoskHQtAwoUZZRX26V2qKc2/q/hq__FpupZ6b3eVaxCUBv1yn26bqscg3b1aEwdHm7qEx5kFAVhfceVWEH65W8oY8p4u7PsGHYSEnUSD/rep/image?authorization=eyJxc3BhY2VfaWQiOiJpc3BjNEJSbW9uVGlnOVFTRDg3TVJXUDhGNWlMZmRjdCIsImFkZHIiOiIweDY2NWFlZTIzMjhmYTQwNDBlNTY5ZTkxYmUyM2ZhZjVhODJhNjE4NmMiLCJxbGliX2lkIjoiaWxpYjM3NjJ2ZW9za0hRdEF3b1VaWlJYMjZWMnFLYzIifQ%3D%3D.RVMyNTZLX1AzODJXdTU2bzJwNlNuVG5GWjlvN3lxQkdFeFFrbUpieExYeVdUMlNmRERyMlFQbnplaE1aZGZVUEJ4TXNKM3JRcm5TczFHY2ExSnlVWDlpZnYyc3A2dVRw"
Source:

static SetAuthContext({contextoptional})

Specify additional context to include in all state channel requests made by the client (e.g. for playout)

Parameters:
Name Type Attributes Description
context Object <optional>

Additional context to include in state channel requests

  • Note: Context must be a map of string->string
Example
 SetAuthContext({
  "context": {
    "custom": "attribute"
  }
});


<No Return Value>
Source: