Class CCDEntriesApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

CCDEntriesApi

Implements

ICCDEntriesApi

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 CCDEntriesApi : ICCDEntriesApi, IApiAccessor

Constructors

CCDEntriesApi(IApiClient)

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

Declaration

public CCDEntriesApi(IApiClient apiClient)

Parameters

Type	Name	Description
IApiClient	apiClient	The client interface for synchronous API access.

CCDEntriesApi(IApiClient, IApiConfiguration)

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

Declaration

public CCDEntriesApi(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

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetEntryByPathPublic(string, string, string, CancellationToken)

Get entry by path Gets a single entry by path for a given bucket.

Declaration

[Obsolete]
public ApiOperation<Entry> GetEntryByPathPublic(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<Entry>	The operation

GetEntryByPathPublicEnv(string, string, string, string, CancellationToken)

Get entry by path Gets a single entry by path for a given bucket.

Declaration

public ApiOperation<Entry> GetEntryByPathPublicEnv(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<Entry>	The operation

GetEntryForBadgeByPathPublic(string, string, string, CancellationToken)

Get entry in a badged release by path Gets a single entry for a given badged release by path.

Declaration

[Obsolete]
public ApiOperation<Entry> GetEntryForBadgeByPathPublic(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<Entry>	The operation

GetEntryForBadgeByPathPublicEnv(string, string, string, string, CancellationToken)

Get entry in a badged release by path Gets a single entry for a given badged release by path.

Declaration

public ApiOperation<Entry> GetEntryForBadgeByPathPublicEnv(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<Entry>	The operation

GetEntryForBadgePublic(string, string, string, CancellationToken)

Get entry in a badged release Gets a single entry for a given badged release.

Declaration

[Obsolete]
public ApiOperation<Entry> GetEntryForBadgePublic(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<Entry>	The operation

GetEntryForBadgePublicEnv(string, string, string, string, CancellationToken)

Get entry in a badged release Gets a single entry for a given badged release.

Declaration

public ApiOperation<Entry> GetEntryForBadgePublicEnv(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<Entry>	The operation

GetEntryForReleaseByPathPublic(string, string, string, CancellationToken)

Get entry in release by path Gets a single entry for a given release by path.

Declaration

[Obsolete]
public ApiOperation<Entry> GetEntryForReleaseByPathPublic(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<Entry>	The operation

GetEntryForReleaseByPathPublicEnv(string, string, string, string, CancellationToken)

Get entry in release by path Gets a single entry for a given release by path.

Declaration

public ApiOperation<Entry> GetEntryForReleaseByPathPublicEnv(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<Entry>	The operation

GetEntryForReleasePublic(string, string, string, CancellationToken)

Get entry in release Gets a single entry for a given release.

Declaration

[Obsolete]
public ApiOperation<Entry> GetEntryForReleasePublic(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<Entry>	The operation

GetEntryForReleasePublicEnv(string, string, string, string, CancellationToken)

Get entry in release Gets a single entry for a given release.

Declaration

public ApiOperation<Entry> GetEntryForReleasePublicEnv(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<Entry>	The operation

GetEntryPublic(string, string, CancellationToken)

Get entry by id Gets a single entry by id for a given bucket.

Declaration

[Obsolete]
public ApiOperation<Entry> GetEntryPublic(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<Entry>	The operation

GetEntryPublicEnv(string, string, string, CancellationToken)

Get entry by id Gets a single entry by id for a given bucket.

Declaration

public ApiOperation<Entry> GetEntryPublicEnv(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<Entry>	The operation

GetEntryVersionPublic(string, string, string, CancellationToken)

Get entry version Gets a specific version of an entry.

Declaration

[Obsolete]
public ApiOperation<Entry> GetEntryVersionPublic(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<Entry>	The operation

GetEntryVersionPublicEnv(string, string, string, string, CancellationToken)

Get entry version Gets a specific version of an entry.

Declaration

public ApiOperation<Entry> GetEntryVersionPublicEnv(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<Entry>	The operation

Implements

ICCDEntriesApi

IApiAccessor