Simias::POBoxService::Web::POBoxService Class Reference

Summary description for POBoxService. More...

Collaboration diagram for Simias::POBoxService::Web::POBoxService:

[legend]

List of all members.

Public Member Functions
	POBoxService ()
int	Ping (int sleepFor)
	Ping Method for clients to determine if POBoxService is up and running.
POBoxStatus	AcceptedSubscription (SubscriptionMsg subMsg)
	Accept subscription.
POBoxStatus	DeclinedSubscription (SubscriptionMsg subMsg)
	Decline subscription.
POBoxStatus	AckSubscription (SubscriptionMsg subMsg)
	Acknowledge the subscription.
SubscriptionInformation	GetSubscriptionInfo (string domainID, string identityID, string subscriptionID, string collectionID)
	Get the subscription information.
void	RemoveCollectionBySubscription (string subscription)
	Creates a subscription in the POBox of the ToUser in the Subscription.
void	RemoveSubscriptionsForCollection (string domainID, string collectionID)
	Removes all subscriptions associated with this collection.
void	RemoveSubscriptionByMember (string domainID, string collectionID, string userID)
	Removes the subscription for this collection from the specified member.
POBoxStatus	Invite (SubscriptionMsg subMsg)
	Invite a user to a shared collection.

---

Detailed Description

Summary description for POBoxService.

---

Constructor & Destructor Documentation

Simias::POBoxService::Web::POBoxService::POBoxService

(

)

[inline]

---

Member Function Documentation

int Simias::POBoxService::Web::POBoxService::Ping

(

int

sleepFor

)

[inline]

Ping Method for clients to determine if POBoxService is up and running.

Parameters:

sleepFor

Returns:

0

POBoxStatus Simias::POBoxService::Web::POBoxService::AcceptedSubscription

(

SubscriptionMsg

subMsg

)

[inline]

Accept subscription.

Parameters:

subMsg

POBoxStatus Simias::POBoxService::Web::POBoxService::DeclinedSubscription

(

SubscriptionMsg

subMsg

)

[inline]

Decline subscription.

Parameters:

subMsg

POBoxStatus Simias::POBoxService::Web::POBoxService::AckSubscription

(

SubscriptionMsg

subMsg

)

[inline]

Acknowledge the subscription.

Parameters:

subMsg

SubscriptionInformation Simias::POBoxService::Web::POBoxService::GetSubscriptionInfo	(	string	domainID,
		string	identityID,
		string	subscriptionID,
		string	collectionID
	)			[inline]

Get the subscription information.

Parameters:

	domainID
	identityID
	subscriptionID
	collectionID

Returns:

success:subinfo failure:null

void Simias::POBoxService::Web::POBoxService::RemoveCollectionBySubscription

(

string

subscription

)

[inline]

Creates a subscription in the POBox of the ToUser in the Subscription.

Parameters:

subscription

Returns:

Removes the collection from the server if the current user is the owner. Otherwise the current user's membership is removed from the collection.

Parameters:

subscription

Subscription to the collection.

void Simias::POBoxService::Web::POBoxService::RemoveSubscriptionsForCollection	(	string	domainID,
		string	collectionID
	)			[inline]

Removes all subscriptions associated with this collection.

void Simias::POBoxService::Web::POBoxService::RemoveSubscriptionByMember	(	string	domainID,
		string	collectionID,
		string	userID
	)			[inline]

Removes the subscription for this collection from the specified member.

Parameters:

member

Member to remove subscription from.

POBoxStatus Simias::POBoxService::Web::POBoxService::Invite

(

SubscriptionMsg

subMsg

)

[inline]

Invite a user to a shared collection.

Parameters:

subMsg

Returns:

True if successful. False if not.

---

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

• src/core/POBoxWS/POBoxService.asmx.cs