Class AddinSerializer

Namespace

Geotab.Checkmate.ObjectModel.AddIns

Assembly

Geotab.Checkmate.ObjectModel.dll

Converts AddIn manifests to and from JSON.

public static class AddinSerializer

Inheritance

object

AddinSerializer

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Deserialize(string)

Deserialize addin from json string.

public static AddIn Deserialize(string addinJson)

Parameters

addinJson string

The addinJson.

Returns

AddIn

returns. AddIn

Deserialize(string, bool)

Deserialize addin from json string.

public static AddIn Deserialize(string addinJson, bool removeInvalidProperties)

Parameters

addinJson string

The addinJson.

removeInvalidProperties bool

The removeInvalidProperties.

Returns

AddIn

returns. AddIn

DeserializeFromSystemSettings(SystemSettings)

Deserialize addins stored in. SystemSettings

public static IEnumerable<AddIn> DeserializeFromSystemSettings(SystemSettings settings)

Parameters

settings SystemSettings

The settings.

Returns

IEnumerable<AddIn>

AddIn

IsAddinConfig(AddIn)

Returns true if addIn represents a configuration AddIn AddIn object.

public static bool IsAddinConfig(AddIn addIn)

Parameters

addIn AddIn

The addin json.

Returns

bool

true if addin has a configuration; otherwise, false.

IsAddinReference(AddIn)

Returns true if addIn represents a reference AddIn AddIn object.

public static bool IsAddinReference(AddIn addIn)

Parameters

addIn AddIn

The addin json.

Returns

bool

true if addin is a reference; otherwise, false.

Serialize(object)

Serialize addin to string.

public static string Serialize(object addin)

Parameters

addin object

The addin.

Returns

string

json

SerializePagesToSystemSettingsPages(IEnumerable<string>)

Serializes collection of SystemSettings customer pages into format that SystemSettings understands.

public static List<string> SerializePagesToSystemSettingsPages(IEnumerable<string> pages)

Parameters

pages IEnumerable<string>

The pages.

Returns

List<string>

list of customer pages

SerializeToSystemSettings(IEnumerable<object>)

Serializes collection of addins into format that SystemSettings understands.

public static List<string> SerializeToSystemSettings(IEnumerable<object> addins)

Parameters

addins IEnumerable<object>

The addins.

Returns

List<string>

system settings