The RelayUri class is responsible for defining functions that construct a URN from a given device or group id or name, as well as functions that parse out certain components from a given Relay URN. More...

Static Public Member Functions
static string	GroupId (string groupId, List< KeyValuePair< string, string >> filter=null)
	Creates a URN from a group ID. More...

static string	GroupName (string groupName, List< KeyValuePair< string, string >> filter=null)
	Creates a URN from a group name. More...

static string	GroupMember (string groupName, string deviceName)
	Creates a URN for a group member More...

static string	DeviceId (string deviceId)
	Creates a URN from a device ID. More...

static string	DeviceName (string deviceName)
	Creates a URN from a device name. More...

static string	InteractionName (string name)
	Creates a URN from an interaction name. More...

static string	InteractionName (string name, IEnumerable< string > devices)
	Creates a URN from an interaction name and devices. More...

static string	AllDevicesWithStatus (string interactionName, string status)
	Returns a URN containing all of the devices with the specified status. More...

static string	AllDevices ()
	Retrieves all of the devices associated with the account. More...

static string	GenericOriginator ()
	Creates a URN containing server information. More...

static string	ParseDeviceName (string uri)
	Parses out a device name from a device or interaction URN. More...

static string	ParseDeviceId (string uri)
	Parses out a device ID from a device or interaction URN. More...

static string	ParseGroupName (string uri)
	Parses out a group name from a group URN. More...

static bool	IsRelayUri (string uri)
	Checks if the URN is a Relay URN. More...

Detailed Description

The RelayUri class is responsible for defining functions that construct a URN from a given device or group id or name, as well as functions that parse out certain components from a given Relay URN.

Member Function Documentation

◆ AllDevices()

static string RelayDotNet.RelayUri.AllDevices ( )

inlinestatic

Retrieves all of the devices associated with the account.

Returns: the devices.

◆ AllDevicesWithStatus()

static string RelayDotNet.RelayUri.AllDevicesWithStatus	(	string	interactionName,
		string	status
	)

inlinestatic

Returns a URN containing all of the devices with the specified status.

Parameters

interactionName	the name of the interaction.
status	the status of the devices.

Returns: a URN containing all of the devices with the status.

◆ DeviceId()

static string RelayDotNet.RelayUri.DeviceId ( string deviceId )

inlinestatic

Creates a URN from a device ID.

Parameters

deviceId the ID of the device.

Returns: the newly constructed URN.

◆ DeviceName()

static string RelayDotNet.RelayUri.DeviceName ( string deviceName )

inlinestatic

Creates a URN from a device name.

Parameters

deviceName the name of the device.

Returns: the newly constructed URN.

◆ GenericOriginator()

static string RelayDotNet.RelayUri.GenericOriginator ( )

inlinestatic

Creates a URN containing server information.

Returns: the newly constructed URN.

◆ GroupId()

static string RelayDotNet.RelayUri.GroupId	(	string	groupId,
		List< KeyValuePair< string, string >>	filter = `null`
	)

inlinestatic

Creates a URN from a group ID.

Parameters

groupId	the ID of the group
filter	optional filter for constructing the URN.

Returns: the newly constructed URN.

◆ GroupMember()

static string RelayDotNet.RelayUri.GroupMember	(	string	groupName,
		string	deviceName
	)

inlinestatic

Creates a URN for a group member

Parameters

groupName	the name of the group that the device belongs to.
deviceName	the device ID or name.

Returns: the newly constructed URN.

◆ GroupName()

static string RelayDotNet.RelayUri.GroupName	(	string	groupName,
		List< KeyValuePair< string, string >>	filter = `null`
	)

inlinestatic

Creates a URN from a group name.

Parameters

groupName	the name of the group.
filter	optional filter for constructing the URN.

Returns: the newly constructed URN.

◆ InteractionName() [1/2]

static string RelayDotNet.RelayUri.InteractionName ( string name )

inlinestatic

Creates a URN from an interaction name.

Parameters

name	the name of the interaction.

Returns: the newly constructed URN.

◆ InteractionName() [2/2]

static string RelayDotNet.RelayUri.InteractionName	(	string	name,
		IEnumerable< string >	devices
	)

inlinestatic

Creates a URN from an interaction name and devices.

Parameters

name	the name of the interaction.
devices	a list of devices.

Returns: the newly constructed URN.

◆ IsRelayUri()

static bool RelayDotNet.RelayUri.IsRelayUri ( string uri )

inlinestatic

Checks if the URN is a Relay URN.

Parameters

uri	the device, group, or interaction URN.

Returns: true if the URN is a Relay URN, false otherwise.

◆ ParseDeviceId()

static string RelayDotNet.RelayUri.ParseDeviceId ( string uri )

inlinestatic

Parses out a device ID from a device or interaction URN.

Parameters

uri	the device or interaction URN that you would like to extract the device ID from.

Returns: the device ID.

◆ ParseDeviceName()

static string RelayDotNet.RelayUri.ParseDeviceName ( string uri )

inlinestatic

Parses out a device name from a device or interaction URN.

Parameters

uri	the device or interaction URN that you would like to extract the device name from.

Returns: the device name.

◆ ParseGroupName()

static string RelayDotNet.RelayUri.ParseGroupName ( string uri )

inlinestatic

Parses out a group name from a group URN.

Parameters

uri	the URN that you would like to extract the group name from.

Returns: the group name.

The documentation for this class was generated from the following file:

RelayUri.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AllDevices()

◆ AllDevicesWithStatus()

◆ DeviceId()

◆ DeviceName()

◆ GenericOriginator()

◆ GroupId()

◆ GroupMember()

◆ GroupName()

◆ InteractionName() [1/2]

◆ InteractionName() [2/2]

◆ IsRelayUri()

◆ ParseDeviceId()

◆ ParseDeviceName()

◆ ParseGroupName()