IGlympse.h

//------------------------------------------------------------------------------
//
// Copyright (c) 2012 Glympse Inc.  All rights reserved.
//
//------------------------------------------------------------------------------

#ifndef IGLYMPSE_H__GLYMPSE__
#define IGLYMPSE_H__GLYMPSE__

namespace Glympse 
{
    
/*O*public**/ struct IGlympse : public IEventSink
{
    public: virtual GEventSink confirmAccount(const GString& type, const GPrimitive& profile) = 0;
 
    public: virtual bool login(const GPrimitive& profile) = 0;

    public: virtual bool logout() = 0;
   
    public: virtual void start() = 0;
    
    public: virtual void stop() = 0;
    
    public: virtual bool isFirstLaunch() = 0;
    
    public: virtual bool isStarted() = 0;
    
    public: virtual int32 setActive(bool active) = 0;
    
    public: virtual bool isActive() = 0;
    
    public: virtual GString getAccessToken() = 0;
    
    public: virtual void setHandler(const GHandler& handler) = 0;
    
    public: virtual GHandler getHandler() = 0;
    
    public: virtual int32 canDeviceSendSms() = 0;
    
    public: virtual void setSmsSendMode(int32 smsSendMode) = 0;
    
    public: virtual int32 getSmsSendMode() = 0;
    
    public: virtual void enableSmsScraping(bool enable) = 0;
    
    public: virtual bool isSmsScrapingEnabled() = 0;
    
    public: virtual void setEtaMode(int32 etaMode) = 0;
    
    public: virtual int32 getEtaMode() = 0;
    
    public: virtual void setRestoreHistory(bool restore) = 0;
    
    public: virtual bool isHistoryRestored() = 0;
    
    public: virtual void setHistoryLookback(int64 interval) = 0;
    
    public: virtual int64 getHistoryLookback() = 0;
    
    public: virtual void allowSiblingTickets(bool allow) = 0;
    
    public: virtual bool areSiblingTicketsAllowed() = 0;
    
    public: virtual void enableInviteViewersTracking(bool enable) = 0;
    
    public: virtual bool isInviteViewersTrackingEnabled() = 0;
    
    public: virtual bool hasUserAccount() = 0;
    
    public: virtual void setBrand(const GString& brand) = 0;
    
    public: virtual GString getBrand() = 0;
    
    public: virtual void enableApplicationsManager(bool enable) = 0;
    
    public: virtual bool isApplicationsManagerEnabled() = 0;
    
    public: virtual GString getBaseUrl() = 0;
    
    public: virtual GString getApiKey() = 0;
    
    public: virtual GString getPrefix() = 0;
    
    public: virtual GConfig getConfig() = 0;
    
    public: virtual GUserManager getUserManager() = 0;
    
    public: virtual GHistoryManager getHistoryManager() = 0;
    
    public: virtual GGroupManager getGroupManager() = 0;        
    
    public: virtual GNetworkManager getNetworkManager() = 0;    
    
    public: virtual GLocationManager getLocationManager() = 0;
    
    public: virtual GBatteryManager getBatteryManager() = 0;  

    public: virtual GLinkedAccountsManager getLinkedAccountsManager() = 0;

    public: virtual GPairingManager getPairingManager() = 0;

    public: virtual GApplicationsManager getApplicationsManager() = 0;

    public: virtual GHandoffManager getHandoffManager() = 0;
    
    public: virtual GDirectionsManager getDirectionsManager() = 0;
    
    public: virtual GSmsProvider getSmsProvider() = 0;
    
    public: virtual GTriggersManager getTriggersManager() = 0;
    
    public: virtual GPlaceSearchEngine getPlaceSearchEngine() = 0;

    public: virtual GFavoritesManager getFavoritesManager() = 0;

    public: virtual GCardManager getCardManager() = 0;
    
    public: virtual GPoiManager getPoiManager() = 0;

    public: virtual GString cleanupInviteCode(const GString& code) = 0;

    public: virtual bool compareInviteCodes(const GString& code1, const GString& code2) = 0;
    
    public: virtual GEventSink decodeInvite(const GString& code, int32 mode) = 0;
    
    public: virtual GEventSink decodeInvite(const GString& code, int32 mode, const GInvite& invite) = 0;
    
    public: virtual bool openUrl(const GString& message, int32 mode, const GInvite& invite) = 0;
    
    public: virtual GArray<GString>::ptr extractInviteCodes(const GString& message) = 0;
    
    public: virtual int32 getInviteAspect(const GString& code) = 0;
    
    public: virtual GImage createInviteSnapshot(const GString& invite, const GPrimitive& parameters, const GPrimitive& style) = 0;        
    
    public: virtual GTicket viewTicket(const GUserTicket& userTicket) = 0;
    
    public: virtual bool sendTicket(const GTicket& ticket) = 0;
    
    public: virtual void requestTicket(const GTicket& ticket) = 0;
    
    public: virtual void verify() = 0;

    public: virtual int64 getTime() = 0;
    
    public: virtual GString getApiVersion() = 0;
    
    public: virtual GString getApiVersionFull() = 0;
    
    public: virtual void showDebugView() = 0;
    
    public: virtual void overrideLoggingLevels(int32 fileLevel, int32 debugLevel) = 0;
    
    public: virtual GString getLogFile() = 0;
    
    public: virtual GArray<GEventSink>::ptr findSinks(const GEventListener& listener) = 0;
    
    public: virtual void registerDeviceToken(const GString& deviceToken) = 0;
    
    public: virtual void registerDeviceToken(const GString& tokenType, const GString& deviceToken) = 0;
    
    public: virtual void unregisterDeviceToken() = 0;
    
    public: virtual void unregisterDeviceToken(const GString& tokenType) = 0;
    
    public: virtual bool hasValidDeviceToken() = 0;
    
    public: virtual bool hasValidDeviceToken(const GString& tokenType) = 0;
    
    public: virtual void handleRemoteNotification(const GString& payload) = 0;
    
    public: virtual void handleRemoteNotification(const GString& payload, const GString& context) = 0;
    
    public: virtual void enablePushEchoing(bool enable) = 0;
    
    public: virtual bool isPushEchoingEbabled() = 0;
};
    
/*C*/typedef O< IGlympse > GGlympse;
    
}

#endif // !IGLYMPSE_H__GLYMPSE__