Simias::POBox::Subscription Class Reference

An Subscription object is a specialized message used for inviting someone to a team space. More...

Inheritance diagram for Simias::POBox::Subscription:

Collaboration diagram for Simias::POBox::Subscription:

List of all members.

Public Member Functions

Subscription (Domain domain, string messageName, string messageType, string fromIdentity)

Constructor for creating a new Subscription object.

Subscription (Node node)

Constructor for creating an existing Subscription object from a Node object.

Subscription (Collection collection, ShallowNode shallowNode)

Constructor for creating an existing Subscription object.

SubscriptionInfo GenerateInfo (Store store)

Generates a SubscriptionInfo object from the Subscription object.

SubscriptionMsg GenerateSubscriptionMessage ()

Generates a SubscriptionInfo object from the Subscription object.

SubscriptionStatus GenerateStatus ()

Generates a SubscriptionStatus object from the Subscription object.

void AddDetails (SubscriptionDetails details)

Add the details to the subscription.

void Accept (Store store, SubscriptionDispositions disposition)

Accept the subscription on the slave side.

Member Accept (Store store, Access.Rights rights)

Accept the subscription on the master side.

void Decline ()

Decline the subscription on the master side.

void CreateSlave (Store store)

Create the slave collection (stub for syncing).

void SetSubscriptionTypes (Collection collection)

Sets all of the Types tags specified on the collection as SubscriptionTypes.

Public Attributes

const string SubscriptionStateProperty = "SbState"

The name of the property storing the SubscriptionState.

const string ToPublicKeyProperty = "ToPKey"

The name of the property storing the recipient's public key.

const string FromPublicKeyProperty = "FromPKey"

The name of the property storing the sender's public key.

const string SubscriptionCollectionNameProperty = "SbColName"

The name of the property storing the collection name.

const string SubscriptionCollectionTypeProperty = "SbColType"

The name of the property storing the shared collection type.

const string CollectionDescriptionProperty = "ColDesc"

The name of the property storing the collection description.

const string DirNodeIDProperty = "DirNodeID"

The name of the property storing the DirNode ID.

const string DirNodeNameProperty = "DirNodeName"

The name of the property storing the DirNode name.

const string SubscriptionRightsProperty = "SbRights"

The name of the property storing the rights requested/granted.

Static Public Attributes

static string DefaultRootPath

default root path for collections

static readonly string SubscriptionCollectionIDProperty = "SbColID"

The name of the property storing the collection ID.

static readonly string SubscriptionCollectionHasDirNodeProperty = "HasDirNode"

The name of the property storing the value that tells if the collection has a DirNode.

static readonly string CollectionRootProperty = "ColRoot"

The name of the property storing the root path of the collection (on the slave).

static readonly string SubscriptionDispositionProperty = "SbDisposition"

The name of the property storing the status of the subscription (accepted, declined, etc.).

static readonly string SubscriptionKeyProperty = "SbKey"

The name of the property storing the subscription key.

static readonly string ToMemberNodeIDProperty = "SbMemberNode"

The To member's node ID in the collection.

static readonly string SubscriptionTypes = "SbTypes"

The type of collection that this subscription represents.

Properties

SubscriptionStates SubscriptionState [get, set]

Gets/sets the state of the Subscription object.

RSACryptoServiceProvider ToPublicKey [get, set]

Gets/sets the recipient's public key.

RSACryptoServiceProvider FromPublicKey [get, set]

Gets/sets the sender's public key.

string SubscriptionCollectionName [get, set]

Gets/sets the name of the collection to share.

string SubscriptionCollectionID [get, set]

Gets/sets the ID of the collection to share.

string SubscriptionCollectionType [get, set]

Gets/sets the type of the collection to share.

string CollectionDescription [get, set]

Gets/sets the description of the collection to share.

string CollectionRoot [get, set]

Gets/sets the collection root path on the slave.

string DirNodeID [get, set]

Gets/sets the ID of the collection's root DirNode.

bool HasDirNode [get, set]

Gets a value indicating if the collection contains a DirNode.

string DirNodeName [get, set]

Gets/sets the name of the collection's root DirNode.

Access.Rights SubscriptionRights [get, set]

Gets/sets the rights that will be granted on the shared collection.

SubscriptionDispositions SubscriptionDisposition [get, set]

Gets/sets the disposition of the subscription.

string SubscriptionKey [get, set]

Gets/sets the subscription key.

string ToMemberNodeID [get, set]

Gets/sets the To user's NODE ID.

string Originator [get, set]

Gets/sets the originator of this subscription.

string[] SbTypes [get, set]

Gets or sets the collection types for this subscription.

string HostID [get, set]

Get or Set the HostID for the collection represented by this subscription.

Detailed Description

An Subscription object is a specialized message used for inviting someone to a team space.

Constructor & Destructor Documentation

Simias::POBox::Subscription::Subscription	(	Domain	domain,
		string	messageName,
		string	messageType,
		string	fromIdentity
	)			`[inline]`

Constructor for creating a new Subscription object.

Parameters:

	domain	The domain that this subscription belongs to.
	messageName	The friendly name of the message.
	messageType	The type of the message.
	fromIdentity	The identity of the sender.

Simias::POBox::Subscription::Subscription ( Node node ) [inline]

Constructor for creating an existing Subscription object from a Node object.

Parameters:

node

The Node object to create the Subscription object from.

Simias::POBox::Subscription::Subscription	(	Collection	collection,
		ShallowNode	shallowNode
	)			`[inline]`

Constructor for creating an existing Subscription object.

Parameters:

	collection	Collection that the ShallowNode belongs to.
	shallowNode	ShallowNode object to create the Subscription object from.

Member Function Documentation

SubscriptionInfo Simias::POBox::Subscription::GenerateInfo ( Store store ) [inline]

Generates a SubscriptionInfo object from the Subscription object.

Returns:: A SubscriptionInfo object

SubscriptionMsg Simias::POBox::Subscription::GenerateSubscriptionMessage ( ) [inline]

Generates a SubscriptionInfo object from the Subscription object.

Returns:: A SubscriptionInfo object

SubscriptionStatus Simias::POBox::Subscription::GenerateStatus ( ) [inline]

Generates a SubscriptionStatus object from the Subscription object.

Returns:: A SubscriptionStatus object

void Simias::POBox::Subscription::AddDetails ( SubscriptionDetails details ) [inline]

Add the details to the subscription.

Parameters:

details

The details object

void Simias::POBox::Subscription::Accept	(	Store	store,
		SubscriptionDispositions	disposition
	)			`[inline]`

Accept the subscription on the slave side.

Parameters:

	store	The store that the POBox belongs to.
	disposition	The disposition to set on the subscription.

Member Simias::POBox::Subscription::Accept	(	Store	store,
		Access.Rights	rights
	)			`[inline]`

Accept the subscription on the master side.

void Simias::POBox::Subscription::Decline ( ) [inline]

Decline the subscription on the master side.

void Simias::POBox::Subscription::CreateSlave ( Store store ) [inline]

Create the slave collection (stub for syncing).

void Simias::POBox::Subscription::SetSubscriptionTypes ( Collection collection ) [inline]

Sets all of the Types tags specified on the collection as SubscriptionTypes.

Parameters:

collection

Collection to get types from.

Member Data Documentation

string Simias::POBox::Subscription::DefaultRootPath [static]

Initial value:

 Path.Combine(
                        Environment.GetFolderPath(
                        Environment.SpecialFolder.Personal),
                        "My Collections")

default root path for collections

const string Simias::POBox::Subscription::SubscriptionStateProperty = "SbState"

The name of the property storing the SubscriptionState.

const string Simias::POBox::Subscription::ToPublicKeyProperty = "ToPKey"

The name of the property storing the recipient's public key.

const string Simias::POBox::Subscription::FromPublicKeyProperty = "FromPKey"

The name of the property storing the sender's public key.

const string Simias::POBox::Subscription::SubscriptionCollectionNameProperty = "SbColName"

The name of the property storing the collection name.

readonly string Simias::POBox::Subscription::SubscriptionCollectionIDProperty = "SbColID" [static]

The name of the property storing the collection ID.

const string Simias::POBox::Subscription::SubscriptionCollectionTypeProperty = "SbColType"

The name of the property storing the shared collection type.

readonly string Simias::POBox::Subscription::SubscriptionCollectionHasDirNodeProperty = "HasDirNode" [static]

The name of the property storing the value that tells if the collection has a DirNode.

const string Simias::POBox::Subscription::CollectionDescriptionProperty = "ColDesc"

The name of the property storing the collection description.

readonly string Simias::POBox::Subscription::CollectionRootProperty = "ColRoot" [static]

The name of the property storing the root path of the collection (on the slave).

const string Simias::POBox::Subscription::DirNodeIDProperty = "DirNodeID"

The name of the property storing the DirNode ID.

const string Simias::POBox::Subscription::DirNodeNameProperty = "DirNodeName"

The name of the property storing the DirNode name.

const string Simias::POBox::Subscription::SubscriptionRightsProperty = "SbRights"

The name of the property storing the rights requested/granted.

readonly string Simias::POBox::Subscription::SubscriptionDispositionProperty = "SbDisposition" [static]

The name of the property storing the status of the subscription (accepted, declined, etc.).

readonly string Simias::POBox::Subscription::SubscriptionKeyProperty = "SbKey" [static]

The name of the property storing the subscription key.

readonly string Simias::POBox::Subscription::ToMemberNodeIDProperty = "SbMemberNode" [static]

The To member's node ID in the collection.

readonly string Simias::POBox::Subscription::SubscriptionTypes = "SbTypes" [static]

The type of collection that this subscription represents.

Property Documentation

SubscriptionStates Simias::POBox::Subscription::SubscriptionState [get, set]

Gets/sets the state of the Subscription object.

RSACryptoServiceProvider Simias::POBox::Subscription::ToPublicKey [get, set]

Gets/sets the recipient's public key.

RSACryptoServiceProvider Simias::POBox::Subscription::FromPublicKey [get, set]

Gets/sets the sender's public key.

string Simias::POBox::Subscription::SubscriptionCollectionName [get, set]

Gets/sets the name of the collection to share.

string Simias::POBox::Subscription::SubscriptionCollectionID [get, set]

Gets/sets the ID of the collection to share.

string Simias::POBox::Subscription::SubscriptionCollectionType [get, set]

Gets/sets the type of the collection to share.

string Simias::POBox::Subscription::CollectionDescription [get, set]

Gets/sets the description of the collection to share.

string Simias::POBox::Subscription::CollectionRoot [get, set]

Gets/sets the collection root path on the slave.

string Simias::POBox::Subscription::DirNodeID [get, set]

Gets/sets the ID of the collection's root DirNode.

bool Simias::POBox::Subscription::HasDirNode [get, set]

Gets a value indicating if the collection contains a DirNode.

string Simias::POBox::Subscription::DirNodeName [get, set]

Gets/sets the name of the collection's root DirNode.

Access.Rights Simias::POBox::Subscription::SubscriptionRights [get, set]

Gets/sets the rights that will be granted on the shared collection.

SubscriptionDispositions Simias::POBox::Subscription::SubscriptionDisposition [get, set]

Gets/sets the disposition of the subscription.

string Simias::POBox::Subscription::SubscriptionKey [get, set]

Gets/sets the subscription key.

string Simias::POBox::Subscription::ToMemberNodeID [get, set]

Gets/sets the To user's NODE ID.

string Simias::POBox::Subscription::Originator [get, set]

Gets/sets the originator of this subscription.

string [] Simias::POBox::Subscription::SbTypes [get, set]

Gets or sets the collection types for this subscription.

string Simias::POBox::Subscription::HostID [get, set]

Get or Set the HostID for the collection represented by this subscription.

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

src/core/POBox/Subscription.cs


Public Member Functions
	Subscription (Domain domain, string messageName, string messageType, string fromIdentity)
	Constructor for creating a new Subscription object.
	Subscription (Node node)
	Constructor for creating an existing Subscription object from a Node object.
	Subscription (Collection collection, ShallowNode shallowNode)
	Constructor for creating an existing Subscription object.
SubscriptionInfo	GenerateInfo (Store store)
	Generates a SubscriptionInfo object from the Subscription object.
SubscriptionMsg	GenerateSubscriptionMessage ()
	Generates a SubscriptionInfo object from the Subscription object.
SubscriptionStatus	GenerateStatus ()
	Generates a SubscriptionStatus object from the Subscription object.
void	AddDetails (SubscriptionDetails details)
	Add the details to the subscription.
void	Accept (Store store, SubscriptionDispositions disposition)
	Accept the subscription on the slave side.
Member	Accept (Store store, Access.Rights rights)
	Accept the subscription on the master side.
void	Decline ()
	Decline the subscription on the master side.
void	CreateSlave (Store store)
	Create the slave collection (stub for syncing).
void	SetSubscriptionTypes (Collection collection)
	Sets all of the Types tags specified on the collection as SubscriptionTypes.
Public Attributes
const string	SubscriptionStateProperty = "SbState"
	The name of the property storing the SubscriptionState.
const string	ToPublicKeyProperty = "ToPKey"
	The name of the property storing the recipient's public key.
const string	FromPublicKeyProperty = "FromPKey"
	The name of the property storing the sender's public key.
const string	SubscriptionCollectionNameProperty = "SbColName"
	The name of the property storing the collection name.
const string	SubscriptionCollectionTypeProperty = "SbColType"
	The name of the property storing the shared collection type.
const string	CollectionDescriptionProperty = "ColDesc"
	The name of the property storing the collection description.
const string	DirNodeIDProperty = "DirNodeID"
	The name of the property storing the DirNode ID.
const string	DirNodeNameProperty = "DirNodeName"
	The name of the property storing the DirNode name.
const string	SubscriptionRightsProperty = "SbRights"
	The name of the property storing the rights requested/granted.
Static Public Attributes
static string	DefaultRootPath
	default root path for collections
static readonly string	SubscriptionCollectionIDProperty = "SbColID"
	The name of the property storing the collection ID.
static readonly string	SubscriptionCollectionHasDirNodeProperty = "HasDirNode"
	The name of the property storing the value that tells if the collection has a DirNode.
static readonly string	CollectionRootProperty = "ColRoot"
	The name of the property storing the root path of the collection (on the slave).
static readonly string	SubscriptionDispositionProperty = "SbDisposition"
	The name of the property storing the status of the subscription (accepted, declined, etc.).
static readonly string	SubscriptionKeyProperty = "SbKey"
	The name of the property storing the subscription key.
static readonly string	ToMemberNodeIDProperty = "SbMemberNode"
	The To member's node ID in the collection.
static readonly string	SubscriptionTypes = "SbTypes"
	The type of collection that this subscription represents.
Properties
SubscriptionStates	SubscriptionState `[get, set]`
	Gets/sets the state of the Subscription object.
RSACryptoServiceProvider	ToPublicKey `[get, set]`
	Gets/sets the recipient's public key.
RSACryptoServiceProvider	FromPublicKey `[get, set]`
	Gets/sets the sender's public key.
string	SubscriptionCollectionName `[get, set]`
	Gets/sets the name of the collection to share.
string	SubscriptionCollectionID `[get, set]`
	Gets/sets the ID of the collection to share.
string	SubscriptionCollectionType `[get, set]`
	Gets/sets the type of the collection to share.
string	CollectionDescription `[get, set]`
	Gets/sets the description of the collection to share.
string	CollectionRoot `[get, set]`
	Gets/sets the collection root path on the slave.
string	DirNodeID `[get, set]`
	Gets/sets the ID of the collection's root DirNode.
bool	HasDirNode `[get, set]`
	Gets a value indicating if the collection contains a DirNode.
string	DirNodeName `[get, set]`
	Gets/sets the name of the collection's root DirNode.
Access.Rights	SubscriptionRights `[get, set]`
	Gets/sets the rights that will be granted on the shared collection.
SubscriptionDispositions	SubscriptionDisposition `[get, set]`
	Gets/sets the disposition of the subscription.
string	SubscriptionKey `[get, set]`
	Gets/sets the subscription key.
string	ToMemberNodeID `[get, set]`
	Gets/sets the To user's NODE ID.
string	Originator `[get, set]`
	Gets/sets the originator of this subscription.
string[]	SbTypes `[get, set]`
	Gets or sets the collection types for this subscription.
string	HostID `[get, set]`
	Get or Set the HostID for the collection represented by this subscription.