TNStropheGlobals.j

/*
 * TNStropheGlobals.j
 *
 * Copyright (C) 2010  Antoine Mercadal <antoine.mercadal@inframonde.eu>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3.0 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#pragma mark -
#pragma mark globals of TNStropheConnection

/*!
    @global
    @group TNStropheConnectionStatus
    Notification sent on connecting
*/
TNStropheConnectionStatusConnecting         = @"TNStropheConnectionStatusConnecting";
/*!
    @global
    @group TNStropheConnectionStatus
    Notification sent when connected
*/
TNStropheConnectionStatusConnected          = @"TNStropheConnectionStatusConnected";
/*!
    @global
    @group TNStropheConnectionStatus
    Notification sent on connection fail
*/
TNStropheConnectionStatusConnectionFailure  = @"TNStropheConnectionStatusConnectionFailure";
/*! @global
    @group TNStropheConnectionStatus
    Notification sent when authenticating

*/
TNStropheConnectionStatusAuthenticating     = @"TNStropheConnectionStatusAuthenticating"
/*!
    @global
    @group TNStropheConnectionStatus
    Notification sent on auth fail
*/
TNStropheConnectionStatusAuthFailure        = @"TNStropheConnectionStatusAuthFailure";

/*!
    @global
    @group TNStropheConnectionStatus
    Notification when strophe is going to disconnect (but it is still connected)
*/
TNStropheConnectionStatusWillDisconnect      = @"TNStropheConnectionStatusWillDisconnect";

/*!
    @global
    @group TNStropheConnectionStatus
    Notification sent on disconnecting
*/
TNStropheConnectionStatusDisconnecting      = @"TNStropheConnectionStatusDisconnecting";

/*!
    @global
    @group TNStropheConnectionStatus
    Notification sent when disconnected
*/
TNStropheConnectionStatusDisconnected       = @"TNStropheConnectionStatusDisconnected";

/*!
    @global
    @group TNStropheConnectionStatus
    Notification sent when other error occurs
*/
TNStropheConnectionStatusError              = @"TNStropheConnectionStatusError";

/*!
    @global
    @group TNStropheConnectionStatus
    Notification sent when the connection status changes
*/
TNStropheConnectionStatusDidChangeNotification  = @"TNStropheConnectionStatusDidChangeNotification";

#pragma mark -
#pragma mark globals of TNStropheClient

/*!
    @global
    @group TNStropheClientPresence
    Notification sent when other connection update presence
*/
TNStropheClientPresenceUpdatedNotification  = @"TNStropheClientPresenceUpdatedNotification";

/*!
    @global
    @group TNStropheClientVCard
    Notification sent on connecting
*/
TNStropheClientVCardReceived                = @"TNStropheClientVCardReceived";

#pragma mark -
#pragma mark globals of TNStropheContact

/*!
    @global
    @group TNStropheContactStatus
    Status away
*/
TNStropheContactStatusAway       = @"away";
/*!
    @global
    @group TNStropheContactStatus
    Status Busy
*/
TNStropheContactStatusBusy       = @"xa";
/*!
    @global
    @group TNStropheContactStatus
    Status Do Not Disturb
*/
TNStropheContactStatusDND        = @"dnd";
/*!
    @global
    @group TNStropheContactStatus
    Status offline
*/
TNStropheContactStatusOffline    = @"offline";
/*!
    @global
    @group TNStropheContactStatus
    Status online
*/
TNStropheContactStatusOnline     = @"online";

/*!
    @global
    @group TNStropheContact
    notification sent when nickname of contact has been updated
*/
TNStropheContactNicknameUpdatedNotification     = @"TNStropheContactNicknameUpdatedNotification";
/*!
    @global
    @group TNStropheContact
    notification sent when group of contact have been updated
*/
TNStropheContactGroupUpdatedNotification        = @"TNStropheContactGroupUpdatedNotification";
/*!
    @global
    @group TNStropheContact
    notification sent when presence status of contact has been updated
*/
TNStropheContactPresenceUpdatedNotification     = @"TNStropheContactPresenceUpdatedNotification";
/*!
    @global
    @group TNStropheContact
    notification sent when subscription status of contact has been updated
*/
TNStropheContactSubscriptionUpdatedNotification = @"TNStropheContactSubscriptionUpdatedNotification";
/*!
    @global
    @group TNStropheContact
    notification sent when contact receive its vCard
*/
TNStropheContactVCardReceivedNotification       = @"TNStropheContactVCardReceivedNotification";
/*!
    @global
    @group TNStropheContact
    notification sent when contact receive a message
*/
TNStropheContactMessageReceivedNotification     = @"TNStropheContactMessageReceivedNotification";
/*!
    @global
    @group TNStropheContact
    notification sent when all messages in messages queue have been treated
*/
TNStropheContactMessageTreatedNotification      = @"TNStropheContactMessageTreatedNotification";
/*!
    @global
    @group TNStropheContact
    notification sent when message have been sent to the contact
*/
TNStropheContactMessageSentNotification         = @"TNStropheContactMessageSentNotification";
/*!
    @global
    @group TNStropheContact
    notification sent when stanza have been sent to the contact
*/
TNStropheContactStanzaSentNotification          = @"TNStropheContactStanzaSentNotification"

/*!
    @global
    @group TNStropheContactMessage
    notification sent when contact is composing a message
*/
TNStropheContactMessageComposing                = @"TNStropheContactMessageComposing";
/*!
    @global
    @group TNStropheContactMessage
    notification sent when contact stops composing a message
*/
TNStropheContactMessagePaused                   = @"TNStropheContactMessagePaused";
/*!
    @global
    @group TNStropheContactMessage
    notification sent when chat with contact is active
*/
TNStropheContactMessageActive                   = @"TNStropheContactMessageActive";
/*!
    @global
    @group TNStropheContactMessage
    notification sent when chat with contact is unactive
*/
TNStropheContactMessageInactive                 = @"TNStropheContactMessageInactive";
/*!
    @global
    @group TNStropheContactMessage
    notification sent when contact leave chat (close window most of the time)
*/
TNStropheContactMessageGone                     = @"TNStropheContactMessageGone";


#pragma mark -
#pragma mark globals of TNStropheRoster

/*!
    @global
    @group TNStropheRoster
    notification indicates that TNStropheRoster has received the data from the XMPP server
*/
TNStropheRosterRetrievedNotification            = @"TNStropheRosterRetrievedNotification";

/*!
    @global
    @group TNStropheRoster
    notification indicates that TNStropheRoster has recieved a push (update of content)
*/
TNStropheRosterPushNotification                 = @"TNStropheRosterPushNotification";

/*!
    @global
    @group TNStropheRoster
    notification indicates that TNStropheRoster has recieved a add push
*/
TNStropheRosterPushAddedContactNotification     = @"TNStropheRosterPushAddedContactNotification";

/*!
    @global
    @group TNStropheRoster
    notification indicates that TNStropheRoster has recieved an update push
*/
TNStropheRosterPushUpdatedContactNotification   = @"TNStropheRosterPushUpdatedContactNotification";

/*!
    @global
    @group TNStropheRoster
    notification indicates that TNStropheRoster has recieved a remove push
*/
TNStropheRosterPushRemovedContactNotification   = @"TNStropheRosterPushRemovedContactNotification";

/*!
    @global
    @group TNStropheRoster
    notification indicates that a new contact has been added to the TNStropheRoster
*/
TNStropheRosterAddedContactNotification     = @"TNStropheRosterAddedContactNotification";
/*!
    @global
    @group TNStropheRoster
    notification indicates that a new contact has been removed from the TNStropheRoster
*/

TNStropheRosterRemovedContactNotification   = @"TNStropheRosterRemovedContactNotification";
/*!
    @global
    @group TNStropheRoster
    notification indicates that a new group has been added to the TNStropheRoster
*/
TNStropheRosterAddedGroupNotification       = @"TNStropheRosterAddedGroupNotification";

/*!
    @global
    @group TNStropheRoster
    notification indicates that a new group has been added to the TNStropheRoster
*/
TNStropheRosterRemovedGroupNotification     = @"TNStropheRosterRemovedGroupNotification";


#pragma mark -
#pragma mark globals of TNStropheGroup

/*!
    @global
    @group TNStropheGroup
    notification indicates that a group has been renamed
*/
TNStropheGroupRenamedNotification = @"TNStropheGroupRenamed";

/*!
    @global
    @group TNStropheGroup
    notification indicates that a group has been removed
*/
TNStropheGroupRemovedNotification = @"TNStropheGroupRemoved";



#pragma mark -
#pragma mark globals for TNPubSubNode

TNStrophePubSubVarTitle                     = @"pubsub#title";
TNStrophePubSubVarDeliverNotification       = @"pubsub#deliver_notifications";
TNStrophePubSubVarDeliverPayloads           = @"pubsub#deliver_payloads";
TNStrophePubSubVarPersistItems              = @"pubsub#persist_items";
TNStrophePubSubVarMaxItems                  = @"pubsub#max_items";
TNStrophePubSubVarItemExpire                = @"pubsub#item_expire";
TNStrophePubSubVarAccessModel               = @"pubsub#access_model";
TNStrophePubSubVarRosterGroupAllowed        = @"pubsub#roster_groups_allowed";
TNStrophePubSubVarPublishModel              = @"pubsub#publish_model";
TNStrophePubSubVarPurgeOffline              = @"pubsub#purge_offline";
TNStrophePubSubVarSendLastPublishedItem     = @"pubsub#send_last_published_item";
TNStrophePubSubVarPresenceBasedDelivery     = @"pubsub#presence_based_delivery";
TNStrophePubSubVarNotificationType          = @"pubsub#notification_type";
TNStrophePubSubVarNotifyConfig              = @"pubsub#notify_config";
TNStrophePubSubVarNotifyDelete              = @"pubsub#notify_delete";
TNStrophePubSubVarNotifyRectract            = @"pubsub#notify_retract";
TNStrophePubSubVarNotifySub                 = @"pubsub#notify_sub";
TNStrophePubSubVarMaxPayloadSize            = @"pubsub#max_payload_size";
TNStrophePubSubVarType                      = @"pubsub#type";
TNStrophePubSubVarBodyXSLT                  = @"pubsub#body_xslt";

TNStrophePubSubVarAccessModelOpen           = @"open";
TNStrophePubSubVarAccessModelRoster         = @"roster";
TNStrophePubSubVarAccessModelAuthorize      = @"authorize";
TNStrophePubSubVarAccessModelWhitelist      = @"whitelist";

/*!
    @global
    @group TNPubSub
    notification indicates that a pubsub node has been recovered
*/
TNStrophePubSubNodeRetrievedNotification    = @"TNStrophePubSubNodeRetrievedNotification";


/*!
    @global
    @group TNPubSub
    notification indicates that a pubsub node has been created
*/
TNStrophePubSubNodeCreatedNotification      = @"TNStrophePubSubNodeCreatedNotification";

/*!
    @global
    @group TNPubSub
    notification indicates that a pubsub node has been deleted
*/
TNStrophePubSubNodeDeletedNotification      = @"TNStrophePubSubNodeDeletedNotification";

/*!
    @global
    @group TNPubSub
    notification indicates that a pubsub node has been configured
*/
TNStrophePubSubNodeConfiguredNotification   = @"TNStrophePubSubNodeConfiguredNotification";

/*!
    @global
    @group TNPubSub
    notification indicates that a pubsub item has been published
*/
TNStrophePubSubItemPublishedNotification    = @"TNStrophePubSubItemPublishedNotification";

/*!
    @global
    @group TNPubSub
    notification indicates that a pubsub item has been retracted
*/
TNStrophePubSubItemRetractedNotification    = @"TNStrophePubSubItemRetractedNotification";

/*!
    @global
    @group TNPubSub
    notification indicates that a pubsub node has been subscribed
*/
TNStrophePubSubNodeSubscribedNotification   = @"TNStrophePubSubNodeSubscribedNotification";

/*!
    @global
    @group TNPubSub
    notification indicates that a pubsub node has been unsubscribed
*/
TNStrophePubSubNodeUnsubscribedNotification = @"TNStrophePubSubNodeUnsubscribedNotification";

/*!
    @global
    @group TNPubSub
    notification indicates that an event has been recieved from the PubSub
*/
TNStrophePubSubNodeEventNotification        = @"TNStrophePubSubNodeEventNotification"


#pragma mark -
#pragma mark globals for TNPubSubController

/*!
    @global
    @group TNPubSub
    notification indicates that the list of current subscriptions has been recieved from the PubSub
*/
TNStrophePubSubSubscriptionsRetrievedNotification   = @"TNStrophePubSubSubscriptionsReceivedNotification";

/*!
    @global
    @group TNPubSub
    notification indicates that all subscriptions have been unsubscribed
*/
TNStrophePubSubNoOldSubscriptionsLeftNotification   = @"TNStrophePubSubNoOldSubscriptionsLeft";

/*!
    @global
    @group TNPubSub
    notification indicates that all subscriptions in a batch have been completed
*/
TNStrophePubSubBatchSubscribeComplete               = @"TNStrophePubSubBatchSubscribeComplete";

/*!
    @global
    @group TNPubSub
    notification indicates that all unsubscriptions in a batch have been completed
*/
TNStrophePubSubBatchUnsubscribeComplete              = @"TNStrophePubSubBatchUnsubscribeComplete";


#pragma mark -
#pragma mark globals for TNStropheMUCRoom

/*!
    @global
    @group TNStropheMUCRoom
    notification indicates that an MUC room roster has been updated
*/
TNStropheMUCRosterWasUpdatedNotification            = @"TNStropheMUCRosterWasUpdatedNotification";

/*!
    @global
    @group TNStropheMUCRoom
    notification indicates that someone has spoken in the MUC room
*/
TNStropheMUCConversationWasUpdatedNotification      = @"TNStropheMUCConversationWasUpdatedNotification";

/*!
    @global
    @group TNStropheMUCRoom
    notification indicates that a MUC room subject has been updated
*/
TNStropheMUCSubjectWasUpdatedNotification           = @"TNStropheMUCSubjectWasUpdatedNotification";

/*!
    @global
    @group TNStropheMUCRoom
    notification indicates that data has been received by the MUC (may be non-standard)
*/
TNStropheMUCDataReceivedNotification                = @"TNStropheMUCDataReceivedNotification";

/*!
    @global
    @group TNStropheMUCRoom
    notification indicates that a MUC member has sent a private message
*/
TNStropheMUCPrivateMessageWasReceivedNotification   = @"TNStropheMUCPrivateMessageWasReceivedNotification";

#pragma mark -
#pragma mark globals for TNStropheMUCRoster

/*!
    @global
    @group TNStropheMUCRoster
    notification indicates that a MUC member has entered the room
*/
TNStropheMUCContactJoinedNotification               = @"TNStropheMUCContactJoinedNotification";

/*!
    @global
    @group TNStropheMUCRoster
    notification indicates that a MUC member has left the room
*/
TNStropheMUCContactLeftNotification                 = @"TNStropheMUCContactLeftNotification";