Class SettingsDeliveryRequest

SettingsDeliveryRequest

Inheritance

object

SettingsDeliveryRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Apis.RemoteConfig

Assembly: Unity.Services.Apis.dll

Syntax

[DataContract(Name = "SettingsDeliveryRequest")]
[Preserve]
public class SettingsDeliveryRequest

Constructors

SettingsDeliveryRequest(string, string, string, string, string, List<string>, List<TypeEnum>, bool, string, string, RequestAttributes)

Initializes a new instance of the SettingsDeliveryRequest class.

Declaration

[Preserve]
public SettingsDeliveryRequest(string projectId = "", string userId = "", string customUserId = null, string environmentId = null, string configType = "settings", List<string> key = null, List<SettingsDeliveryRequest.TypeEnum> type = null, bool isDebugBuild = false, string packageVersion = "2.0.0", string attributionMetadata = "", RequestAttributes attributes = null)

Parameters

Type	Name	Description
string	projectId	The projectId for the requesting Unity project. (required) (default to "").
string	userId	The userID for the user requesting settings. (required) (default to "").
string	customUserId	An optional custom userID..
string	environmentId	An optional environmentID to choose a non-default environment..
string	configType	An optional configType. Defaults to 'settings' (default to "settings").
List<string>	key	An optional array of filters for including settings with keys containing any of the specified values.
List<SettingsDeliveryRequest.TypeEnum>	type	An optional array of filters for including settings with specific types.
bool	isDebugBuild	Should be set to 'true' when the request is coming from a debug build. (default to false).
string	packageVersion	Used to specify what Remote Config package version sent the request. (default to "2.0.0").
string	attributionMetadata	Used to specify the origin of the request for attribution. (default to "").
RequestAttributes	attributes	attributes.

Properties

Attributes

Gets or Sets Attributes

Declaration

[DataMember(Name = "attributes", EmitDefaultValue = false)]
[Preserve]
public RequestAttributes Attributes { get; set; }

Property Value

Type	Description
RequestAttributes

AttributionMetadata

Used to specify the origin of the request for attribution.

Declaration

[DataMember(Name = "attributionMetadata", EmitDefaultValue = false)]
[Preserve]
public string AttributionMetadata { get; set; }

Property Value

Type	Description
string	Used to specify the origin of the request for attribution.

ConfigType

An optional configType. Defaults to 'settings'

Declaration

[DataMember(Name = "configType", EmitDefaultValue = false)]
[Preserve]
public string ConfigType { get; set; }

Property Value

Type	Description
string	An optional configType. Defaults to 'settings'

CustomUserId

An optional custom userID.

Declaration

[DataMember(Name = "customUserId", EmitDefaultValue = false)]
[Preserve]
public string CustomUserId { get; set; }

Property Value

Type	Description
string	An optional custom userID.

EnvironmentId

An optional environmentID to choose a non-default environment.

Declaration

[DataMember(Name = "environmentId", EmitDefaultValue = false)]
[Preserve]
public string EnvironmentId { get; set; }

Property Value

Type	Description
string	An optional environmentID to choose a non-default environment.

IsDebugBuild

Should be set to 'true' when the request is coming from a debug build.

Declaration

[DataMember(Name = "isDebugBuild", EmitDefaultValue = true)]
[Preserve]
public bool IsDebugBuild { get; set; }

Property Value

Type	Description
bool	Should be set to 'true' when the request is coming from a debug build.

Key

An optional array of filters for including settings with keys containing any of the specified values

Declaration

[DataMember(Name = "key", EmitDefaultValue = false)]
[Preserve]
public List<string> Key { get; set; }

Property Value

Type	Description
List<string>	An optional array of filters for including settings with keys containing any of the specified values

PackageVersion

Used to specify what Remote Config package version sent the request.

Declaration

[DataMember(Name = "packageVersion", EmitDefaultValue = false)]
[Preserve]
public string PackageVersion { get; set; }

Property Value

Type	Description
string	Used to specify what Remote Config package version sent the request.

ProjectId

The projectId for the requesting Unity project.

Declaration

[DataMember(Name = "projectId", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string ProjectId { get; set; }

Property Value

Type	Description
string	The projectId for the requesting Unity project.

Type

An optional array of filters for including settings with specific types

Declaration

[DataMember(Name = "type", EmitDefaultValue = false)]
[Preserve]
public List<SettingsDeliveryRequest.TypeEnum> Type { get; set; }

Property Value

Type	Description
List<SettingsDeliveryRequest.TypeEnum>	An optional array of filters for including settings with specific types

UserId

The userID for the user requesting settings.

Declaration

[DataMember(Name = "userId", IsRequired = true, EmitDefaultValue = true)]
[Preserve]
public string UserId { get; set; }

Property Value

Type	Description
string	The userID for the user requesting settings.