Skip to content

XMediator::Api::CustomProperties

A container class for key-value custom properties. Use Builder to create an instance of this class.

Public Classes

Name
class Builder
A convenience class for creating CustomProperties.

Public Functions

Name
int? GetInt(string key)
long? GetLong(string key)
float? GetFloat(string key)
double? GetDouble(string key)
string GetString(string key)
IEnumerable< string > GetStringSet(string key)
IDictionary< string, object > GetAll()
Gets all the custom properties as a dictionary.
Builder NewBuilder()
Creates a new Builder with the current key-value pairs from this object.

Public Functions Documentation

function GetInt

int? GetInt(
    string key
)

function GetLong

long? GetLong(
    string key
)

function GetFloat

float? GetFloat(
    string key
)

function GetDouble

double? GetDouble(
    string key
)

function GetString

string GetString(
    string key
)

function GetStringSet

IEnumerable< string > GetStringSet(
    string key
)

function GetAll

IDictionary< string, object > GetAll()

Gets all the custom properties as a dictionary.

Return: A dictionary containing all the custom properties.

function NewBuilder

Builder NewBuilder()

Creates a new Builder with the current key-value pairs from this object.

Return: A new Builder with the current properties.


Updated on 2025-05-03 at 22:32:16 +0000