IInvite.h

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

#ifndef IINVITE_H__GLYMPSE__
#define IINVITE_H__GLYMPSE__

namespace Glympse 
{

/*C*/
struct IUser;
typedef O< IUser > GUser;
struct ITicket;    
typedef O< ITicket > GTicket;
struct IInvite;
typedef O< IInvite > GInvite;

    
/*C*/
struct IInviteViewers;
typedef O< IInviteViewers > GInviteViewers;


/*O*public**/ struct IInvite : public IComparable
{
    public: virtual int32 getType() = 0;    

    public: virtual GString getSubtype() = 0;
    
    public: virtual GString getName() = 0;    
    
    public: virtual GString getAddress() = 0;

    public: virtual void setBrand(const GString& brand) = 0;
    
    public: virtual void applyBrand(const GString& brand) = 0;
    
    public: virtual GString getBrand() = 0;
    
    public: virtual void setVisible(bool visible) = 0;
    
    public: virtual bool isVisible() = 0;
    
    public: virtual bool isCreateOnly() = 0;

    public: virtual void setCreateOnly(bool createOnly) = 0;

    public: virtual GString getCode() = 0;
    
    public: virtual GString getReference() = 0;

    public: virtual void setReference(const GString& reference) = 0;

    public: virtual GString getUrl() = 0;    
    
    public: virtual int32 getState() = 0;
    
    public: virtual int64 getCreatedTime() = 0;
    
    public: virtual int64 getLastViewTime() = 0;    
    
    public: virtual int32 getViewers() = 0;
    
    public: virtual int32 getViewing() = 0;
    
    public: virtual GInviteViewers getViewerUsers() = 0;
    
    public: virtual GInviteViewers getViewingUsers() = 0;
    
    public: virtual bool initiateClientSideSend() = 0;    
    
    public: virtual bool completeClientSideSend(bool succeeded) = 0;
    
    public: virtual GString getText() = 0;        
    
    public: virtual void setRequestTicket(const GTicket& requestTicket) = 0;

    public: virtual GTicket getRequestTicket() = 0;

    public: virtual GServerError getError() = 0;
    
    public: virtual GInvite clone() = 0;  
};
    
}

#endif // !IINVITE_H__GLYMPSE__