Skip to content

XMediator::Api::InitSettings

A configuration object used during SDK initialization. XMediatorSdk.Initialize

Public Functions

Name
InitSettings(bool test =false, bool verbose =false, string clientVersion =null, IEnumerable< string > placementIds =null, UserProperties userProperties =null, ConsentInformation consentInformation =null)
Creates a new InitSettings instance.
override bool Equals(object obj)
override int GetHashCode()
override string ToString()

Protected Functions

Name
bool Equals(InitSettings other)

Public Properties

Name
bool Test
bool Verbose
string ClientVersion
IEnumerable< string > PlacementIds
UserProperties UserProperties
ConsentInformation ConsentInformation

Public Functions Documentation

function InitSettings

InitSettings(
    bool test =false,
    bool verbose =false,
    string clientVersion =null,
    IEnumerable< string > placementIds =null,
    UserProperties userProperties =null,
    ConsentInformation consentInformation =null
)

Creates a new InitSettings instance.

Parameters:

  • test Whether the SDK should be initialized in test mode. This is only for testing purposes, should be false on production builds.
  • verbose Enable logging for this session. This is only for debugging purposes, should be false on production builds.
  • clientVersion Optional. A string identifying the version of who interacts with the SDK.
  • placementIds Optional. A collection of placements ids that will be used during this session.
  • userProperties A UserProperties object containing useful information during initialization.
  • consentInformation A ConsentInformation object containing user consent information.

function Equals

override bool Equals(
    object obj
)

function GetHashCode

override int GetHashCode()

function ToString

override string ToString()

Protected Functions Documentation

function Equals

bool Equals(
    InitSettings other
)

Public Property Documentation

property Test

bool Test;

property Verbose

bool Verbose;

property ClientVersion

string ClientVersion;

property PlacementIds

IEnumerable< string > PlacementIds;

property UserProperties

UserProperties UserProperties;

property ConsentInformation

ConsentInformation ConsentInformation;

Updated on 2024-11-07 at 18:31:49 +0000