docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class CCDContentApi

    Represents a collection of functions to interact with the API endpoints

    Inheritance
    object
    CCDContentApi
    Implements
    ICCDContentApi
    IApiAccessor
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Unity.Services.Apis.CloudContentDelivery
    Assembly: solution.dll
    Syntax
    public class CCDContentApi : ICCDContentApi, IApiAccessor

    Constructors

    CCDContentApi(IApiClient)

    Initializes a new instance of the CCDContentApi class using a Configuration object and client instance.

    Declaration
    public CCDContentApi(IApiClient apiClient)
    Parameters
    Type Name Description
    IApiClient apiClient

    The client interface for synchronous API access.

    CCDContentApi(IApiClient, IApiConfiguration)

    Initializes a new instance of the CCDContentApi class using a Configuration object and client instance.

    Declaration
    public CCDContentApi(IApiClient apiClient, IApiConfiguration apiConfiguration)
    Parameters
    Type Name Description
    IApiClient apiClient

    The client interface for synchronous API access.

    IApiConfiguration apiConfiguration

    The configuration object.

    Properties

    Client

    The client for accessing this underlying API asynchronously.

    Declaration
    public IApiClient Client { get; }
    Property Value
    Type Description
    IApiClient

    Configuration

    Gets the configuration object

    Declaration
    public IApiConfiguration Configuration { get; }
    Property Value
    Type Description
    IApiConfiguration

    An instance of the Configuration

    Methods

    GetBadgedReleaseContentByPathPublic(string, string, string, CancellationToken)

    Get content in badged release by path Gets the content for an entry in a badged release by path.

    Declaration
    [Obsolete]
    public ApiOperation<Stream> GetBadgedReleaseContentByPathPublic(string bucketid, string badgename, string path, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string badgename

    Badge Name

    string path

    Path

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetBadgedReleaseContentByPathPublicEnv(string, string, string, string, CancellationToken)

    Get content in badged release by path Gets the content for an entry in a badged release by path.

    Declaration
    public ApiOperation<Stream> GetBadgedReleaseContentByPathPublicEnv(string environmentname, string bucketid, string badgename, string path, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string badgename

    Badge Name

    string path

    Path

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetBadgedReleaseContentPublic(string, string, string, CancellationToken)

    Get content for entry from a badged release Gets the content for an entry in a badged release.

    Declaration
    [Obsolete]
    public ApiOperation<Stream> GetBadgedReleaseContentPublic(string bucketid, string badgename, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string badgename

    Badge Name

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetBadgedReleaseContentPublicEnv(string, string, string, string, CancellationToken)

    Get content for entry from a badged release Gets the content for an entry in a badged release.

    Declaration
    public ApiOperation<Stream> GetBadgedReleaseContentPublicEnv(string environmentname, string bucketid, string badgename, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string badgename

    Badge Name

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetBadgedReleaseContentStatusByPathPublic(string, string, string, CancellationToken)

    Get content status of an entry by path from a badged release Gets the status of uploaded content in a badged release by path.

    Declaration
    [Obsolete]
    public ApiOperation GetBadgedReleaseContentStatusByPathPublic(string bucketid, string badgename, string path, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string badgename

    Badge Name

    string path

    Path

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetBadgedReleaseContentStatusByPathPublicEnv(string, string, string, string, CancellationToken)

    Get content status of an entry by path from a badged release Gets the status of uploaded content in a badged release by path.

    Declaration
    public ApiOperation GetBadgedReleaseContentStatusByPathPublicEnv(string environmentname, string bucketid, string badgename, string path, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string badgename

    Badge Name

    string path

    Path

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetBadgedReleaseContentStatusPublic(string, string, string, CancellationToken)

    Get content status of an entry from a badged release Gets the status of uploaded content for a given entry from a badged release.

    Declaration
    [Obsolete]
    public ApiOperation GetBadgedReleaseContentStatusPublic(string bucketid, string badgename, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string badgename

    Badge Name

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetBadgedReleaseContentStatusPublicEnv(string, string, string, string, CancellationToken)

    Get content status of an entry from a badged release Gets the status of uploaded content for a given entry from a badged release.

    Declaration
    public ApiOperation GetBadgedReleaseContentStatusPublicEnv(string environmentname, string bucketid, string badgename, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string badgename

    Badge Name

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetBasePath()

    Gets the base path of the API client.

    Declaration
    public string GetBasePath()
    Returns
    Type Description
    string

    The base path

    GetContentByPathPublic(string, string, string, CancellationToken)

    Get content by path Gets the content for an entry by path.

    Declaration
    [Obsolete]
    public ApiOperation<Stream> GetContentByPathPublic(string bucketid, string path, string versionid = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string path

    Path

    string versionid

    Version ID (optional)

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetContentByPathPublicEnv(string, string, string, string, CancellationToken)

    Get content by path Gets the content for an entry by path.

    Declaration
    public ApiOperation<Stream> GetContentByPathPublicEnv(string environmentname, string bucketid, string path, string versionid = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string path

    Path

    string versionid

    Version ID (optional)

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetContentPublic(string, string, CancellationToken)

    Get content for entry Gets the content for a given entry.

    Declaration
    [Obsolete]
    public ApiOperation<Stream> GetContentPublic(string bucketid, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetContentPublicEnv(string, string, string, CancellationToken)

    Get content for entry Gets the content for a given entry.

    Declaration
    public ApiOperation<Stream> GetContentPublicEnv(string environmentname, string bucketid, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetContentStatusByPathPublic(string, string, string, CancellationToken)

    Get content status by path Gets the status of uploaded content by path.

    Declaration
    [Obsolete]
    public ApiOperation GetContentStatusByPathPublic(string bucketid, string path, string versionid = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string path

    Path

    string versionid

    Version ID (optional)

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetContentStatusByPathPublicEnv(string, string, string, string, CancellationToken)

    Get content status by path Gets the status of uploaded content by path.

    Declaration
    public ApiOperation GetContentStatusByPathPublicEnv(string environmentname, string bucketid, string path, string versionid = null, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string path

    Path

    string versionid

    Version ID (optional)

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetContentStatusPublic(string, string, CancellationToken)

    Get content status for entry Gets the status of uploaded content for a given entry.

    Declaration
    [Obsolete]
    public ApiOperation GetContentStatusPublic(string bucketid, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetContentStatusPublicEnv(string, string, string, CancellationToken)

    Get content status for entry Gets the status of uploaded content for a given entry.

    Declaration
    public ApiOperation GetContentStatusPublicEnv(string environmentname, string bucketid, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetContentStatusVersionPublic(string, string, string, CancellationToken)

    Get content status for version of entry Gets the status of uploaded content for a specific version of an entry.

    Declaration
    [Obsolete]
    public ApiOperation GetContentStatusVersionPublic(string bucketid, string entryid, string versionid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string entryid

    Entry ID

    string versionid

    Version ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetContentStatusVersionPublicEnv(string, string, string, string, CancellationToken)

    Get content status for version of entry Gets the status of uploaded content for a specific version of an entry.

    Declaration
    public ApiOperation GetContentStatusVersionPublicEnv(string environmentname, string bucketid, string entryid, string versionid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string entryid

    Entry ID

    string versionid

    Version ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetContentVersionPublic(string, string, string, CancellationToken)

    Get content for version of entry Gets the content for a specific version of an entry.

    Declaration
    [Obsolete]
    public ApiOperation<Stream> GetContentVersionPublic(string bucketid, string entryid, string versionid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string entryid

    Entry ID

    string versionid

    Version ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetContentVersionPublicEnv(string, string, string, string, CancellationToken)

    Get content for version of entry Gets the content for a specific version of an entry.

    Declaration
    public ApiOperation<Stream> GetContentVersionPublicEnv(string environmentname, string bucketid, string entryid, string versionid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string entryid

    Entry ID

    string versionid

    Version ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetReleaseContentByPathPublic(string, string, string, CancellationToken)

    Get content in release by path Gets the content for an entry in a release by path.

    Declaration
    [Obsolete]
    public ApiOperation<Stream> GetReleaseContentByPathPublic(string bucketid, string releaseid, string path, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string releaseid

    Release ID

    string path

    Path

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetReleaseContentByPathPublicEnv(string, string, string, string, CancellationToken)

    Get content in release by path Gets the content for an entry in a release by path.

    Declaration
    public ApiOperation<Stream> GetReleaseContentByPathPublicEnv(string environmentname, string bucketid, string releaseid, string path, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string releaseid

    Release ID

    string path

    Path

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetReleaseContentPublic(string, string, string, CancellationToken)

    Get content for entry Gets the content for a given entry.

    Declaration
    [Obsolete]
    public ApiOperation<Stream> GetReleaseContentPublic(string bucketid, string releaseid, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string releaseid

    Release ID

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetReleaseContentPublicEnv(string, string, string, string, CancellationToken)

    Get content for entry Gets the content for a given entry.

    Declaration
    public ApiOperation<Stream> GetReleaseContentPublicEnv(string environmentname, string bucketid, string releaseid, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string releaseid

    Release ID

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation<Stream>

    The operation

    GetReleaseContentStatusByPathPublic(string, string, string, CancellationToken)

    Get content status in release by path Gets the status of uploaded content in a release by path.

    Declaration
    [Obsolete]
    public ApiOperation GetReleaseContentStatusByPathPublic(string bucketid, string releaseid, string path, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string releaseid

    Release ID

    string path

    Path

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetReleaseContentStatusByPathPublicEnv(string, string, string, string, CancellationToken)

    Get content status in release by path Gets the status of uploaded content in a release by path.

    Declaration
    public ApiOperation GetReleaseContentStatusByPathPublicEnv(string environmentname, string bucketid, string releaseid, string path, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string releaseid

    Release ID

    string path

    Path

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetReleaseContentStatusPublic(string, string, string, CancellationToken)

    Get content status for entry Gets the status of uploaded content for a given entry.

    Declaration
    [Obsolete]
    public ApiOperation GetReleaseContentStatusPublic(string bucketid, string releaseid, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string bucketid

    Bucket ID

    string releaseid

    Release ID

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    GetReleaseContentStatusPublicEnv(string, string, string, string, CancellationToken)

    Get content status for entry Gets the status of uploaded content for a given entry.

    Declaration
    public ApiOperation GetReleaseContentStatusPublicEnv(string environmentname, string bucketid, string releaseid, string entryid, CancellationToken cancellationToken = default)
    Parameters
    Type Name Description
    string environmentname

    Environment Name

    string bucketid

    Bucket ID

    string releaseid

    Release ID

    string entryid

    Entry ID

    CancellationToken cancellationToken

    Cancellation Token to cancel the request.

    Returns
    Type Description
    ApiOperation

    The operation

    Implements

    ICCDContentApi
    IApiAccessor
    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)