Class Presence

Class for handling the root element of a PIDF-LO presence XML document. See RFC 4119.

Inheritance

object

Presence

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pidf

Assembly: Ng911Lib.dll

Syntax

[Serializable]
public class Presence

Constructors

| Edit this page View Source

Presence()

Default constructor.

Declaration

public Presence()

Fields

| Edit this page View Source

device

Contains location information about a device.

Declaration

public Device device

Field Value

Type	Description
Device

| Edit this page View Source

entity

The URI of the entity whose presence the XML document describes.

Declaration

public string entity

Field Value

Type	Description
string

| Edit this page View Source

note

Contains human readable comments text. Optional.

Declaration

public string note

Field Value

Type	Description
string

| Edit this page View Source

person

Contains location information about a person.

Declaration

public Person person

Field Value

Type	Description
Person

| Edit this page View Source

tuple

Umbrella element that has id, status and contact elements.

Declaration

public Tuple tuple

Field Value

Type	Description
Tuple

Methods

| Edit this page View Source

CreateDevicePresence(string)

Creates a new device style Presence object with empty sub-elements up to and including the location-info element.

Declaration

public static Presence CreateDevicePresence(string id)

Parameters

Type	Name	Description
string	id	Specifies the id attribute of the device element. May be null.

Returns

Type	Description
Presence	Returns a new device style Presence object.

| Edit this page View Source

CreatePersonPresence(string)

Creates a new person style Presence object with empty sub-elements up to and including the location-info element.

Declaration

public static Presence CreatePersonPresence(string id)

Parameters

Type	Name	Description
string	id	Specifies the id attribute of the person element. May be null.

Returns

Type	Description
Presence	Returns a new person style Presence object.

| Edit this page View Source

CreateTuplePresence(string)

Creates a new tuple style Presence object with empty sub-elements up to and including the location-info element.

Declaration

public static Presence CreateTuplePresence(string id)

Parameters

Type	Name	Description
string	id	Specifies the id attribute of the tuple element. May be null.

Returns

Type	Description
Presence	Returns a new tuple style Presence object.

| Edit this page View Source

GetAllGeoPrivObjects()

Builds a list of all GeoPriv objects in this Presence object.

Declaration

public List<GeoPriv> GetAllGeoPrivObjects()

Returns

Type	Description
List<GeoPriv>	Returns a list of objects. The return value will always be non-null but may be empty.

| Edit this page View Source

GetFirstCivicAddress()

Gets the first instance of a CivicAddress by searching through all possible locations stored in this Presence object.

Declaration

public CivicAddress GetFirstCivicAddress()

Returns

Type	Description
CivicAddress	Returns the first CivicAddress that is found. Returns null if there are no civic addresses.

| Edit this page View Source

GetFirstCivicAddressLocation()

Gets the first location-info object that has a CivicAddress in it.

Declaration

public locInfoType GetFirstCivicAddressLocation()

Returns

Type	Description
locInfoType	Returns a locInfoType object if there is civic address data in this Presence object. Returns null if no civic address data is available.

| Edit this page View Source

GetFirstCivicGeoPriv()

Gets the first GeoPriv object that contains a civic location.

Declaration

public GeoPriv GetFirstCivicGeoPriv()

Returns

Type	Description
GeoPriv	Returns a GeoPriv object that contains a CivicAddress or null if one is not found.

| Edit this page View Source

GetFirstGeoGeoPriv()

Gets the first GeoPriv object that has a geodetic shape in it.

Declaration

public GeoPriv GetFirstGeoGeoPriv()

Returns

Type	Description
GeoPriv	Returns a GeoPriv object that contains a geodetic shape or null if one is not found.

| Edit this page View Source

GetFirstGeoPriv()

Gets the first geopriv object.

Declaration

public GeoPriv GetFirstGeoPriv()

Returns

Type	Description
GeoPriv	Returns the first geopriv object or null if there are none available.

| Edit this page View Source

GetFirstGeolocation()

Gets the first location-info object that has at least one geolocation in it.

Declaration

public locInfoType GetFirstGeolocation()

Returns

Type	Description
locInfoType	Returns the first location-info object that contains some geolocation data. Returns null if there is no geolocation data available.

| Edit this page View Source

GetFirstServiceInfo()

Gets the first ServiceInfoType object by-value from the provided-by element.

Declaration

public ServiceInfoType GetFirstServiceInfo()

Returns

Type	Description
ServiceInfoType	Returns the first ServiceInfoType object or null if one is not available.

| Edit this page View Source

GetFirstSubscriberInfo()

Gets the first SubscriberInfoType object by-value from the provided-by element.

Declaration

public SubscriberInfoType GetFirstSubscriberInfo()

Returns

Type	Description
SubscriberInfoType	Returns the first SubscriberInfoType object or null if one is not available.