Public Member Functions | |
| Promise< IContentObject > | GetContent (string contentId, string manifestID="") |
| Get the content data for a requested content id. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache. More... | |
| Promise< IContentObject > | GetContent (string contentId, Type contentType, string manifestID="") |
| Get the content data for a requested content id. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache. More... | |
| Promise< IContentObject > | GetContent (IContentRef reference, string manifestID="") |
| Get the content data for a requested IContentRef. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache. More... | |
| Promise< TContent > | GetContent< TContent > (IContentRef reference, string manifestID="") |
| Get the content data for a requested IContentRef. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache. More... | |
| Promise< TContent > | GetContent< TContent > (IContentRef< TContent > reference, string manifestID="") |
| Get the content data for a requested IContentRef<TContent>. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache. More... | |
| Promise< ClientManifest > | GetManifestWithID (string manifestID="") |
| A ClientManifest describes all the content available in a manifest for a realm. This method will always start a network request to get the manifest from Beamable. More... | |
| Promise< ClientManifest > | GetManifest (string filter="", string manifestID="") |
| A ClientManifest describes all the content available in a manifest for a realm. This method will always start a network request to get the manifest from Beamable. More... | |
| Promise< ClientManifest > | GetManifest (ContentQuery query, string manifestID="") |
| A ClientManifest describes all the content available in a manifest for a realm. This method will always start a network request to get the manifest from Beamable. More... | |
 Public Member Functions inherited from Beamable.Common.Api.ISupportsGet< ClientManifest > | |
| Promise< TData > | GetCurrent (string scope="") |
| Manually fetch the available data. If the server hasn't delivered a new update, this method will not return the absolute latest data unless you pass forceRefresh as true. More... | |
Member Function Documentation
◆ GetContent() [1/3]
| Promise< IContentObject > Beamable.Common.Api.Content.IContentApi.GetContent | ( | IContentRef | reference, |
| string | manifestID = "" |
||
| ) |
Get the content data for a requested IContentRef. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache.
- Parameters
-
reference A IContentRef that contains a fully qualified content id. manifestID By default, use the "global" manifest. A realm can have multiple groupings of content, where each group has its own manifest. If you haven't published multiple manifests, you should not use this field.
- Returns
- A Promise<IContentObject> that returns a IContentObject for the given content reference
Implemented in Beamable.Content.ContentService.
◆ GetContent() [2/3]
| Promise< IContentObject > Beamable.Common.Api.Content.IContentApi.GetContent | ( | string | contentId, |
| string | manifestID = "" |
||
| ) |
Get the content data for a requested content id. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache.
- Parameters
-
contentId A content id should be a dot separated string, with at least 1 dot. The right-most clause represents the content's name, and everything else represents the content's type. manifestID By default, use the "global" manifest. A realm can have multiple groupings of content, where each group has its own manifest. If you haven't published multiple manifests, you should not use this field.
- Returns
- A Promise<IContentObject> that returns a IContentObject for the given content id.
Implemented in Beamable.Content.ContentService.
◆ GetContent() [3/3]
| Promise< IContentObject > Beamable.Common.Api.Content.IContentApi.GetContent | ( | string | contentId, |
| Type | contentType, | ||
| string | manifestID = "" |
||
| ) |
Get the content data for a requested content id. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache.
- Parameters
-
contentId A content id should be a dot separated string, with at least 1 dot. The right-most clause represents the content's name, and everything else represents the content's type. contentType If you know the type of the content, you can pass it so that the resulting IContentObject will be castable to the given contentType manifestID By default, use the "global" manifest. A realm can have multiple groupings of content, where each group has its own manifest. If you haven't published multiple manifests, you should not use this field.
- Returns
- A Promise<IContentObject> that returns a IContentObject for the given content id
Implemented in Beamable.Content.ContentService.
◆ GetContent< TContent >() [1/2]
| Promise< TContent > Beamable.Common.Api.Content.IContentApi.GetContent< TContent > | ( | IContentRef | reference, |
| string | manifestID = "" |
||
| ) |
Get the content data for a requested IContentRef. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache.
- Parameters
-
reference A IContentRef that contains a fully qualified content id. manifestID By default, use the "global" manifest. A realm can have multiple groupings of content, where each group has its own manifest. If you haven't published multiple manifests, you should not use this field.
- Template Parameters
-
TContent The type of the content that the reference refers to.
- Returns
- A Promise<TContent> that returns a TContent for the given content reference
Implemented in Beamable.Content.ContentService.
- Type Constraints
-
TContent : ContentObject TContent : new()
◆ GetContent< TContent >() [2/2]
| Promise< TContent > Beamable.Common.Api.Content.IContentApi.GetContent< TContent > | ( | IContentRef< TContent > | reference, |
| string | manifestID = "" |
||
| ) |
Get the content data for a requested IContentRef<TContent>. The content is stored on Beamable servers and cached on each player's device. This method will always get the latest version of the content. Each time there is a new version, this method will cause a network call. Once the version has been cached, this method will read from the cache.
- Parameters
-
reference A IContentRef that contains a fully qualified content id. manifestID By default, use the "global" manifest. A realm can have multiple groupings of content, where each group has its own manifest. If you haven't published multiple manifests, you should not use this field.
- Template Parameters
-
TContent The type of the content that the reference refers to.
- Returns
- A Promise<TContent> that returns a TContent for the given content reference
Implemented in Beamable.Content.ContentService.
- Type Constraints
-
TContent : ContentObject TContent : new()
◆ GetManifest() [1/2]
| Promise< ClientManifest > Beamable.Common.Api.Content.IContentApi.GetManifest | ( | ContentQuery | query, |
| string | manifestID = "" |
||
| ) |
A ClientManifest describes all the content available in a manifest for a realm. This method will always start a network request to get the manifest from Beamable.
- Parameters
-
query A ContentQuery that will be used to down filter the resulting ClientContentInfo entries in the ClientManifest manifestID By default, use the "global" manifest. A realm can have multiple groupings of content, where each group has its own manifest. If you haven't published multiple manifests, you should not use this field.
- Returns
- A Promise<ClientManifest> that will complete when the latest ClientManifest has been received from Beamable. The manifest will only include entries that passed the given filter
Implemented in Beamable.Content.ContentService.
◆ GetManifest() [2/2]
| Promise< ClientManifest > Beamable.Common.Api.Content.IContentApi.GetManifest | ( | string | filter = "", |
| string | manifestID = "" |
||
| ) |
A ClientManifest describes all the content available in a manifest for a realm. This method will always start a network request to get the manifest from Beamable.
- Parameters
-
filter A string version of a ContentQuery that will be used to down filter the resulting ClientContentInfo entries in the ClientManifest manifestID By default, use the "global" manifest. A realm can have multiple groupings of content, where each group has its own manifest. If you haven't published multiple manifests, you should not use this field.
- Returns
- A Promise<ClientManifest> that will complete when the latest ClientManifest has been received from Beamable. The manifest will only include entries that passed the given filter
Implemented in Beamable.Content.ContentService.
◆ GetManifestWithID()
| Promise< ClientManifest > Beamable.Common.Api.Content.IContentApi.GetManifestWithID | ( | string | manifestID = "" | ) |
A ClientManifest describes all the content available in a manifest for a realm. This method will always start a network request to get the manifest from Beamable.
- Parameters
-
manifestID By default, use the "global" manifest. A realm can have multiple groupings of content, where each group has its own manifest. If you haven't published multiple manifests, you should not use this field.
- Returns
- A Promise<ClientManifest> that will complete when the latest ClientManifest has been received from Beamable.
Implemented in Beamable.Content.ContentService.
The documentation for this interface was generated from the following file:
- com.beamable/Common/Runtime/Api/Content/IContentApi.cs
