@voipsdk/react-native-voipcloud 1.0.1 → 1.0.2

package/ios/VoipCloud.xcframework/ios-arm64/Headers/pjsua2/presence.hpp

@@ -0,0 +1,368 @@
+/*
+ * Copyright (C) 2013 Teluu Inc. (http://www.teluu.com)
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+#ifndef __PJSUA2_PRESENCE_HPP__
+#define __PJSUA2_PRESENCE_HPP__
+
+/**
+ * @file pjsua2/presence.hpp
+ * @brief PJSUA2 Presence Operations
+ */
+#include <pjsua2/persistent.hpp>
+#include <pjsua2/siptypes.hpp>
+
+/** PJSUA2 API is inside pj namespace */
+namespace pj
+{
+
+/**
+ * @defgroup PJSUA2_PRES Presence
+ * @ingroup PJSUA2_Ref
+ * @{
+ */
+
+using std::string;
+using std::vector;
+
+
+/**
+ * This describes presence status.
+ */
+struct PresenceStatus
+{
+    /**
+     * Buddy's online status.
+     */
+    pjsua_buddy_status   status;
+
+    /**
+     * Text to describe buddy's online status.
+     */
+    string               statusText;
+    
+    /**
+     * Activity type.
+     */
+    pjrpid_activity      activity;
+
+    /**
+     * Optional text describing the person/element.
+     */
+    string               note;
+
+    /**
+     * Optional RPID ID string.
+     */
+    string               rpidId;
+
+public:
+    /**
+     * Constructor.
+     */
+    PresenceStatus();
+};
+
+
+/**
+ * This structure describes buddy configuration when adding a buddy to
+ * the buddy list with Buddy::create().
+ */
+struct BuddyConfig : public PersistentObject
+{
+    /**
+     * Buddy URL or name address.
+     */
+    string               uri;
+
+    /**
+     * Specify whether presence subscription should start immediately.
+     */
+    bool                 subscribe;
+
+public:
+    /**
+     * Read this object from a container node.
+     *
+     * @param node              Container to read values from.
+     */
+    virtual void readObject(const ContainerNode &node) PJSUA2_THROW(Error);
+
+    /**
+     * Write this object to a container node.
+     *
+     * @param node              Container to write values to.
+     */
+    virtual void writeObject(ContainerNode &node) const PJSUA2_THROW(Error);
+};
+
+
+/**
+ * This structure describes buddy info, which can be retrieved by via
+ * Buddy::getInfo().
+ */
+struct BuddyInfo
+{
+    /**
+     * The full URI of the buddy, as specified in the configuration.
+     */
+    string               uri;
+
+    /**
+     * Buddy's Contact, only available when presence subscription has
+     * been established to the buddy.
+     */
+    string               contact;
+
+    /**
+     * Flag to indicate that we should monitor the presence information for
+     * this buddy (normally yes, unless explicitly disabled).
+     */
+    bool                 presMonitorEnabled;
+
+    /**
+     * If \a presMonitorEnabled is true, this specifies the last state of
+     * the presence subscription. If presence subscription session is currently
+     * active, the value will be PJSIP_EVSUB_STATE_ACTIVE. If presence
+     * subscription request has been rejected, the value will be
+     * PJSIP_EVSUB_STATE_TERMINATED, and the termination reason will be
+     * specified in \a subTermReason.
+     */
+    pjsip_evsub_state    subState;
+
+    /**
+     * String representation of subscription state.
+     */
+    string               subStateName;
+
+    /**
+     * Specifies the last presence subscription termination code. This would
+     * return the last status of the SUBSCRIBE request. If the subscription
+     * is terminated with NOTIFY by the server, this value will be set to
+     * 200, and subscription termination reason will be given in the
+     * \a subTermReason field.
+     */
+    pjsip_status_code    subTermCode;
+
+    /**
+     * Specifies the last presence subscription termination reason. If 
+     * presence subscription is currently active, the value will be empty.
+     */
+    string               subTermReason;
+
+    /**
+     * Presence status.
+     */
+    PresenceStatus       presStatus;
+
+public:
+    /**
+     * Default constructor
+     */
+    BuddyInfo() 
+    : presMonitorEnabled(true),
+      subState(PJSIP_EVSUB_STATE_UNKNOWN),
+      subTermCode(PJSIP_SC_NULL)
+    {}
+                    
+
+    /** Import from pjsip structure */
+    void fromPj(const pjsua_buddy_info &pbi);
+};
+
+
+/**
+ * This structure contains parameters for Buddy::onBuddyEvSubState() callback.
+ */
+struct OnBuddyEvSubStateParam
+{
+    /**
+     * * The event which triggers state change event.
+     */
+    SipEvent    e;
+};
+
+
+/**
+ * Buddy. This is a lite wrapper class for PJSUA-LIB buddy, i.e: this class
+ * only maintains one data member, PJSUA-LIB buddy ID, and the methods are
+ * simply proxies for PJSUA-LIB buddy operations.
+ *
+ * Application can use create() to register a buddy to PJSUA-LIB, and
+ * the destructor of the original instance (i.e: the instance that calls
+ * create()) will unregister and delete the buddy from PJSUA-LIB. Application
+ * must delete all Buddy instances belong to an account before shutting down
+ * the account (via Account::shutdown()).
+ *
+ * The library will not keep a list of Buddy instances, so any Buddy (or
+ * descendant) instances instantiated by application must be maintained
+ * and destroyed by the application itself. Any PJSUA2 APIs that return Buddy
+ * instance(s) such as Account::enumBuddies2() or Account::findBuddy2() will
+ * just return generated copy. All Buddy methods should work normally on this
+ * generated copy instance.
+ */
+class Buddy
+{
+public:
+    /**
+     * Constructor.
+     */
+    Buddy();
+    
+    /**
+     * Destructor. Note that if the Buddy original instance (i.e: the instance
+     * that calls Buddy::create()) is destroyed, it will also delete the
+     * corresponding buddy in the PJSUA-LIB. While the destructor of
+     * a generated copy (i.e: Buddy instance returned by PJSUA2 APIs such as
+     * Account::enumBuddies2() or Account::findBuddy2()) will do nothing.
+     */
+    virtual ~Buddy();
+    
+    /**
+     * Create buddy and register the buddy to PJSUA-LIB.
+     *
+     * Note that application should maintain the Buddy original instance, i.e:
+     * the instance that calls this create() method as it is only the original
+     * instance destructor that will delete the underlying Buddy in PJSUA-LIB.
+     *
+     * @param acc               The account for this buddy.
+     * @param cfg               The buddy config.
+     */
+    void create(Account &acc, const BuddyConfig &cfg) PJSUA2_THROW(Error);
+    
+    /**
+     * Check if this buddy is valid.
+     *
+     * @return                  True if it is.
+     */
+    bool isValid() const;
+
+    /**
+     * Get PJSUA-LIB buddy ID or index associated with this buddy.
+     *
+     * @return                  Integer greater than or equal to zero.
+     */
+    int getId() const;
+
+    /**
+     * Get detailed buddy info.
+     *
+     * @return                  Buddy info.
+     */
+    BuddyInfo getInfo() const PJSUA2_THROW(Error);
+
+    /**
+     * Enable/disable buddy's presence monitoring. Once buddy's presence is
+     * subscribed, application will be informed about buddy's presence status
+     * changed via \a onBuddyState() callback.
+     *
+     * @param subscribe         Specify true to activate presence
+     *                          subscription.
+     */
+    void subscribePresence(bool subscribe) PJSUA2_THROW(Error);
+    
+    /**
+     * Update the presence information for the buddy. Although the library
+     * periodically refreshes the presence subscription for all buddies,
+     * some application may want to refresh the buddy's presence subscription
+     * immediately, and in this case it can use this function to accomplish
+     * this.
+     *
+     * Note that the buddy's presence subscription will only be initiated
+     * if presence monitoring is enabled for the buddy. See
+     * subscribePresence() for more info. Also if presence subscription for
+     * the buddy is already active, this function will not do anything.
+     *
+     * Once the presence subscription is activated successfully for the buddy,
+     * application will be notified about the buddy's presence status in the
+     * \a onBuddyState() callback.
+     */
+     void updatePresence(void) PJSUA2_THROW(Error);
+     
+    /**
+     * Send instant messaging outside dialog, using this buddy's specified
+     * account for route set and authentication.
+     *
+     * @param prm       Sending instant message parameter.
+     */
+    void sendInstantMessage(const SendInstantMessageParam &prm)
+                            PJSUA2_THROW(Error);
+
+    /**
+     * Send typing indication outside dialog.
+     *
+     * @param prm       Sending instant message parameter.
+     */
+    void sendTypingIndication(const SendTypingIndicationParam &prm)
+         PJSUA2_THROW(Error);
+
+public:
+    /*
+     * Callbacks
+     */
+     
+    /**
+     * Notify application when the buddy state has changed.
+     * Application may then query the buddy info to get the details.
+     */
+    virtual void onBuddyState()
+    {}
+
+    /**
+     * Notify application when the state of client subscription session
+     * associated with a buddy has changed. Application may use this
+     * callback to retrieve more detailed information about the state
+     * changed event.
+     *
+     * @param prm       Callback parameter.
+     */
+    virtual void onBuddyEvSubState(OnBuddyEvSubStateParam &prm)
+    { PJ_UNUSED_ARG(prm); }
+     
+private:
+     /**
+      * Buddy ID.
+      */
+    pjsua_buddy_id       id;
+
+private:
+    friend class Endpoint;
+    friend class Account;
+
+    /* Internal constructor/methods used by Endpoint and Account */
+    Buddy(pjsua_buddy_id buddy_id);
+    Buddy *getOriginalInstance();
+};
+
+
+/**
+ * Warning: deprecated, use BuddyVector2 instead.
+ *
+ * Array of buddies.
+ */
+typedef std::vector<Buddy*> BuddyVector;
+
+/** Array of buddies */
+typedef std::vector<Buddy> BuddyVector2;
+
+
+/**
+ * @}  // PJSUA2_PRES
+ */
+
+} // namespace pj
+
+#endif  /* __PJSUA2_PRESENCE_HPP__ */