chat

Documentation

Index

• Constants
• Variables
• type DirectMessage
  • func GetDirectMessage(ID string) (chat *DirectMessage, err error)
• type GroupChat
  • func GetGroupChat(ID string) (chat *GroupChat, err error)
  • func (gc *GroupChat) HandleAccess(dataSubjectId string, currentDocumentID string) map[string]interface{}
  • func (m *GroupChat) HandleDeletion(dataSubjectId string) (nodesToTraverse []pal.Locator, deleteNode bool, ...)
• type Message
  • func (m *Message) HandleAccess(dataSubjectId string, currentDocumentID string) map[string]interface{}
  • func (m *Message) HandleDeletion(dataSubjectId string) (nodesToTraverse []pal.Locator, deleteNode bool, ...)
• type User
  • func CreateUser(name string) (user *User, err error)
  • func GetUser(ID string) (user *User, err error)
  • func (u *User) CreateDirectMessage(user2ID string) (chat *DirectMessage, err error)
  • func (u *User) CreateGroupChat() (chat *GroupChat, err error)
  • func (u *User) HandleAccess(dataSubjectId string, currentDocumentID string) map[string]interface{}
  • func (u *User) HandleDeletion(dataSubjectId string) (nodesToTraverse []pal.Locator, deleteNode bool, ...)
  • func (u *User) JoinOrQuitGroupChat(chatID string, action joinQuitAction) (err error)
  • func (u *User) SendMessageToDirectMessage(chatID string, message string) error
  • func (u *User) SendMessageToGroupChat(chatID string, message string) error

Constants

const (
	FirestoreUsersCollection          = "users"
	FirestoreGroupChatCollection      = "gcs"
	FirestoreDirectMessagesCollection = "dms"
	FirestoreMessagesCollection       = "messages"
)

const (
	JoinChat joinQuitAction = "join"
	QuitChat joinQuitAction = "quit"
)

Variables

var App *firebaseSDK.App

App is a global variable to hold the initialized Firebase App object

var Context context.Context

Types

type DirectMessage

type DirectMessage struct {
	ID       string    `firestore:"id,omitempty"`
	User1    string    `firestore:"user1"`
	User2    string    `firestore:"user2"`
	Messages []Message `firestore:"-"` // subcollection
}

func GetDirectMessage

func GetDirectMessage(ID string) (chat *DirectMessage, err error)

type GroupChat

type GroupChat struct {
	ID       string    `firestore:"id,omitempty"`
	Owner    string    `firestore:"owner"`
	Users    []string  `firestore:"users"`
	Messages []Message `firestore:"-"` // subcollection
}

func GetGroupChat

func GetGroupChat(ID string) (chat *GroupChat, err error)

func (*GroupChat) HandleAccess

func (gc *GroupChat) HandleAccess(dataSubjectId string, currentDocumentID string) map[string]interface{}

func (*GroupChat) HandleDeletion

func (m *GroupChat) HandleDeletion(dataSubjectId string) (nodesToTraverse []pal.Locator, deleteNode bool, fieldsToUpdate []firestore.Update)

type Message

type Message struct {
	ID        string    `firestore:"id,omitempty"`
	UserID    string    `firestore:"userId"`
	Content   string    `firestore:"content"`
	Timestamp time.Time `firestore:"timestamp"`
}

func (*Message) HandleAccess

func (m *Message) HandleAccess(dataSubjectId string, currentDocumentID string) map[string]interface{}

func (*Message) HandleDeletion

func (m *Message) HandleDeletion(dataSubjectId string) (nodesToTraverse []pal.Locator, deleteNode bool, fieldsToUpdate []firestore.Update)

type User

type User struct {
	ID   string            `firestore:"id,omitempty"`
	Name string            `firestore:"name"`
	GCs  []string          `firestore:"gcs"`
	DMs  map[string]string `firestore:"dms"` // map from other user id to dm id
}

func CreateUser

func CreateUser(name string) (user *User, err error)

func GetUser

func GetUser(ID string) (user *User, err error)

func (*User) CreateDirectMessage

func (u *User) CreateDirectMessage(user2ID string) (chat *DirectMessage, err error)

func (*User) CreateGroupChat

func (u *User) CreateGroupChat() (chat *GroupChat, err error)

func (*User) HandleAccess

func (u *User) HandleAccess(dataSubjectId string, currentDocumentID string) map[string]interface{}

func (*User) HandleDeletion

func (u *User) HandleDeletion(dataSubjectId string) (nodesToTraverse []pal.Locator, deleteNode bool, fieldsToUpdate []firestore.Update)

func (*User) JoinOrQuitGroupChat

func (u *User) JoinOrQuitGroupChat(chatID string, action joinQuitAction) (err error)

func (*User) SendMessageToDirectMessage

func (u *User) SendMessageToDirectMessage(chatID string, message string) error

func (*User) SendMessageToGroupChat

func (u *User) SendMessageToGroupChat(chatID string, message string) error