Documentation
¶
Index ¶
- type AddFavorite
- type AllEvents
- type Attachment
- type Attachments
- type Block
- type BlockEvent
- type BlockScaleValue
- type BlockTemplate
- type BlockTemplates
- type BlockType
- type BlockTypes
- type BlockTypesKey
- type BlockTypesKeys
- type BlockWithPodType
- type BlockedUser
- type Blocks
- type BlocksAndPods
- type Checklist
- type ChecklistItem
- type ChecklistItems
- type Checklists
- type Comment
- type Comments
- type Conversation
- type ConversationMessage
- type Conversations
- type Dashboard
- type DashboardBlock
- type DashboardPod
- type DashboardResources
- type DashboardTask
- type DashboardUnreadCount
- type DueDateEvent
- type DueShortlyResources
- type EndDateEvent
- type Favorite
- type FavoriteBlock
- type FavoriteKey
- type FavoriteResource
- type Favorites
- type FilteredKey
- type FilteredKeys
- type Key
- type KeyTemplate
- type KeyTemplates
- type KeyTemplatesWithType
- type Keys
- type LinkedResources
- type LinkedResourcesKey
- type Member
- type Note
- type Notes
- type Notification
- type NotificationEvent
- type NotificationResource
- type Notifications
- type Performer
- type Pod
- type PodEvent
- type PodScaleValue
- type PodTemplate
- type PodTemplates
- type PodType
- type PodTypes
- type PodTypesKey
- type PodTypesKeys
- type PodTypesKeysBlockPod
- type PodTypesKeysKeyPod
- type PodTypesKeysOtherPod
- type Pods
- type Preference
- type Profile
- type RecentComment
- type RecentComments
- type RecentlyModifiedKeys
- type RecentlyModifiedResources
- type Relations
- type Relationships
- type ResourceAttribute
- type ResourceAttributes
- type Scale
- type ScaleValues
- type Scales
- type ScalesKey
- type ScalesKeys
- type ScalesKeysBlock
- type ScalesKeysBlockPod
- type ScalesKeysKeyPod
- type ScalesKeysOtherPod
- type SchedulerEvent
- type SearchResource
- type SearchResources
- type SearchUser
- type SearchUsers
- type SharedUser
- type StandaloneEvent
- type TaggedUser
- type Task
- type TaskEvent
- type TaskStatus
- type Tasks
- type TasksEvent
- type TasksStatusBlock
- type TasksStatusKey
- type TasksStatusKeys
- type UpdateBlockScaleValue
- type UpdatePodScaleValue
- type User
- type UserBlock
- type UserKey
- type UserKeys
- type UserRegistration
- type Users
- type Version
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddFavorite ¶
type AddFavorite struct {
ID string `json:"id"`
}
type AllEvents ¶
type AllEvents struct {
DueDateEvent *DueDateEvent `json:"dueDate"`
EndDateEvent *EndDateEvent `json:"endDate"`
SchedulerEvents []SchedulerEvent `json:"schedulerEvents"`
}
type Attachment ¶
type Attachment struct {
ID string `json:"id"`
FileName string `json:"fileName"`
FileUrl string `json:"fileUrl"`
FileSize string `json:"fileSize"`
Creator common.ResourceCreator `json:"creator"`
Modifier common.ResourceModifier `json:"modifier"`
LastModified string `json:"lastModified"`
}
type Attachments ¶
type Attachments struct {
Attachments []Attachment `json:"files"`
}
type Block ¶
type Block struct {
ID string `json:"id"`
Name string `json:"blockName"`
BlockId string `json:"blockId"`
Description string `json:"blockDescription"`
SimpleDescription string `json:"simpleDescription"`
Color string `json:"color"`
Tags string `json:"tags"`
ScaleValue *string `json:"scaleValue"`
Attributes []common2.DisplayAttribute `json:"attributes"`
BlockType *BlockType `json:"blockType"`
Scale *Scale `json:"scale"`
TaggedUsers []TaggedUser `json:"taggedUsers"`
Key *common2.SlimKey `json:"key"`
// Boolean Attributes
Completed *bool `json:"completed"`
Archived *bool `json:"archived"`
KanbanMode *bool `json:"kanbanMode"`
CanUnlink *bool `json:"canUnlink"`
PublicKey *bool `json:"publicKey"`
// Time Attributes
DueDate string `json:"blockDueDate"`
StartTime string `json:"blockStartTime"`
EndTime string `json:"blockEndTime"`
// Acl Attributes
Acl *string `json:"acl"`
CanLeave *bool `json:"canLeave"`
AllowDelete *bool `json:"allowDelete"`
CanDelete *bool `json:"canDelete"`
CurrentUserAcl SharedUser `json:"currentUserAcl"`
// Count Attributes
KeysCount *int `json:"keysCount"`
PodsCount *int `json:"podsCount"`
TasksCount *int `json:"tasksCount"`
ChecklistsCount *int `json:"checklistsCount"`
AttachmentsCount *int `json:"attachmentsCount"`
CommentsCount *int `json:"commentsCount"`
NotesCount *int `json:"notesCount"`
Creator common2.ResourceCreator `json:"creator"`
Modifier common2.ResourceModifier `json:"modifier"`
LastModified string `json:"lastModified"`
}
type BlockEvent ¶
type BlockScaleValue ¶
type BlockTemplate ¶
type BlockTemplate struct {
ID string `json:"id"`
Name string `json:"templateName"`
Description string `json:"templateDescription"`
Color string `json:"color"`
Tags string `json:"tags"`
PreviewUrl string `json:"previewUrl"`
Archived bool `json:"archived"`
KeyTemplateId *string `json:"keyTemplateId"`
LastModified string `json:"lastModified"`
}
type BlockTemplates ¶
type BlockTemplates struct {
Templates []BlockTemplate `json:"templates"`
}
type BlockTypes ¶
type BlockTypes struct {
BlockTypes []BlockType `json:"blockTypes"`
}
type BlockTypesKey ¶
type BlockTypesKeys ¶
type BlockTypesKeys struct {
Keys []BlockTypesKey `json:"keys"`
}
type BlockWithPodType ¶
type BlockedUser ¶
type BlocksAndPods ¶
type Checklist ¶
type Checklist struct {
ID string `json:"id"`
Title string `json:"title"`
ChecklistItems []ChecklistItem `json:"checklistItems"`
Key *common2.SlimKey `json:"key"`
Creator common2.ResourceCreator `json:"creator"`
Modifier common2.ResourceModifier `json:"modifier"`
}
type ChecklistItem ¶
type ChecklistItem struct {
ID string `json:"id"`
ItemTitle string `json:"title"`
Completed bool `json:"completed"`
TaggedUsers []TaggedUser `json:"taggedUsers"`
ItemSequence *int `json:"checklistItemSeq"`
Creator *common2.ResourceCreator `json:"creator"`
Modifier *common2.ResourceModifier `json:"modifier"`
}
type ChecklistItems ¶
type ChecklistItems struct {
ChecklistItems []ChecklistItem `json:"checklistItems"`
}
type Checklists ¶
type Checklists struct {
Checklists []Checklist `json:"checklists"`
}
type Comment ¶
type Comment struct {
ID string `json:"id"`
CommentText string `json:"commentText"`
TaggedUsers []TaggedUser `json:"taggedUsers"`
CanEdit *bool `json:"canEdit"`
CanDelete *bool `json:"canDelete"`
Key *common2.SlimKey `json:"key"`
Block *common2.SlimBlock `json:"block"`
Pod *common2.SlimPod `json:"pod"`
Creator common2.ResourceCreator `json:"creator"`
Modifier common2.ResourceModifier `json:"modifier"`
LastModified string `json:"lastModified"`
}
type Conversation ¶
type Conversation struct {
ID string `json:"id"`
Type string `json:"type"`
RecentMessage string `json:"recentMessage"`
IsGroup bool `json:"isGroup"`
UserBlocked bool `json:"blockedUser"`
UserLeft bool `json:"leftConversation"`
UserCanLeave bool `json:"canLeave"`
Archived bool `json:"archived"`
AllMessagesRead bool `json:"allMessagesRead"`
Members []Member `json:"members"`
Messages *[]ConversationMessage `json:"messages"`
LastModified string `json:"lastModified"`
}
type ConversationMessage ¶
type Conversations ¶
type Conversations struct {
Conversations []Conversation `json:"conversations"`
}
type Dashboard ¶
type Dashboard struct {
Dashboard DashboardResources `json:"dashboard"`
}
type DashboardBlock ¶
type DashboardBlock struct {
ID string `json:"id"`
Name string `json:"blockName"`
DueDate string `json:"blockDueDate"`
Key *common2.SlimKey `json:"key"`
BlockType *BlockType `json:"blockType"`
Creator common2.ResourceCreator `json:"creator"`
Modifier common2.ResourceModifier `json:"modifier"`
}
type DashboardPod ¶
type DashboardPod struct {
ID string `json:"id"`
Name string `json:"podName"`
DueDate string `json:"podDueDate"`
Key *common2.SlimKey `json:"key"`
Blocks *[]BlockWithPodType `json:"blocks"`
Creator common2.ResourceCreator `json:"creator"`
Modifier common2.ResourceModifier `json:"modifier"`
}
type DashboardResources ¶
type DashboardResources struct {
RecentlyModifiedResources *RecentlyModifiedResources `json:"recentlyModified"`
ShortlyDueResources *DueShortlyResources `json:"dueShortly"`
}
type DashboardTask ¶
type DashboardTask struct {
ID string `json:"id"`
Name string `json:"taskName"`
DueDate string `json:"taskDueDate"`
Key *common2.SlimKey `json:"key"`
Block *common2.SlimBlock `json:"block"`
Pod *common2.SlimPod `json:"pod"`
Blocks *[]common2.SlimBlock `json:"blocks"`
Creator common2.ResourceCreator `json:"creator"`
Modifier common2.ResourceModifier `json:"modifier"`
}
type DashboardUnreadCount ¶
type DueDateEvent ¶
type DueDateEvent struct {
Tasks TasksEvent `json:"tasks"`
Blocks []BlockEvent `json:"blocks"`
Pods []PodEvent `json:"pods"`
}
type DueShortlyResources ¶
type DueShortlyResources struct {
Blocks *[]DashboardBlock `json:"blocks"`
Pods []DashboardPod `json:"pods"`
Tasks []DashboardTask `json:"tasks"`
}
type EndDateEvent ¶
type EndDateEvent struct {
Blocks []BlockEvent `json:"blocks"`
}
type Favorite ¶
type Favorite struct {
ID string `json:"id"`
Modifier common.ResourceModifier `json:"modifier"`
Resource FavoriteResource `json:"resource"`
}
type FavoriteBlock ¶
type FavoriteBlock struct {
ID string `json:"id"`
Name string `json:"blockName"`
Modifier common.ResourceModifier `json:"modifier"`
}
type FavoriteKey ¶
type FavoriteKey struct {
ID string `json:"id"`
Name string `json:"keyName"`
Modifier common.ResourceModifier `json:"modifier"`
}
type FavoriteResource ¶
type FavoriteResource struct {
ID string `json:"id"`
ResourceType string `json:"resourceType"`
KeyName *string `json:"keyName"`
BlockName *string `json:"blockName"`
PodName *string `json:"podName"`
Key *FavoriteKey `json:"key"`
Block *FavoriteBlock `json:"block"`
Modifier common.ResourceModifier `json:"modifier"`
}
type FilteredKey ¶
type FilteredKey struct {
ID string `json:"id"`
Name string `json:"keyName"`
Type string `json:"keyType"`
CreatedByMe BlocksAndPods `json:"createdByMe"`
}
type FilteredKeys ¶
type FilteredKeys struct {
Keys []FilteredKey `json:"keys"`
}
type Key ¶
type Key struct {
ID string `json:"id"`
Name string `json:"keyName"`
Type string `json:"keyType"`
Description string `json:"keyDescription"`
SimpleDescription string `json:"simpleDescription"`
Color string `json:"color"`
Tags string `json:"tags"`
Attributes []common.DisplayAttribute `json:"attributes"`
// Boolean Attributes
Archived *bool `json:"archived"`
KanbanMode *bool `json:"kanbanMode"`
Public *bool `json:"public"`
// Count Attributes
BlocksCount *int `json:"blocksCount"`
PodsCount *int `json:"podsCount"`
TasksCount *int `json:"tasksCount"`
ChecklistsCount *int `json:"checklistsCount"`
NotesCount *int `json:"notesCount"`
Creator common.ResourceCreator `json:"creator"`
Modifier common.ResourceModifier `json:"modifier"`
LastModified string `json:"lastModified"`
}
type KeyTemplate ¶
type KeyTemplates ¶
type KeyTemplates struct {
Templates []KeyTemplatesWithType `json:"templates"`
}
type KeyTemplatesWithType ¶
type KeyTemplatesWithType struct {
Type string `json:"type"`
Templates []KeyTemplate `json:"templates"`
}
type LinkedResources ¶
type LinkedResources struct {
CurrentKey LinkedResourcesKey `json:"currentKey"`
Keys *[]UserKey `json:"keys"`
Blocks []UserBlock `json:"blocks"`
}
type LinkedResourcesKey ¶
type Note ¶
type Note struct {
ID string `json:"id"`
NoteText string `json:"noteText"`
Creator common.ResourceCreator `json:"creator"`
Modifier common.ResourceModifier `json:"modifier"`
LastModified string `json:"lastModified"`
}
type Notification ¶
type Notification struct {
ID string `json:"id"`
Type string `json:"badgeType"` // See above
Text string `json:"badgeText"` // See above
Unread bool `json:"unread"`
Resource NotificationResource `json:"resource"`
}
type NotificationEvent ¶
type NotificationResource ¶
type NotificationResource struct {
ID string `json:"id"`
ResourceType string `json:"resourceType"`
IsTask *bool `json:"isTask"`
KeyName *string `json:"keyName"`
BlockName *string `json:"blockName"`
PodName *string `json:"podName"`
Key *common2.SlimKey `json:"key"`
Blocks *[]common2.SlimBlock `json:"blocks"`
StartTime *string `json:"eventStartTime"`
EndTime *string `json:"eventEndTime"`
}
type Notifications ¶
type Notifications struct {
//TODO(Anish,3,03/23/23): Rename `badges` to `notifications` first on gateway post processor and then here.
Notifications []Notification `json:"badges"`
}
type Pod ¶
type Pod struct {
ID string `json:"id"`
Name string `json:"podName"`
Description string `json:"podDescription"`
SimpleDescription string `json:"simpleDescription"`
Color string `json:"color"`
Tags string `json:"tags"`
ScaleValue *string `json:"scaleValue"`
Attributes []common2.DisplayAttribute `json:"attributes"`
PodType *PodType `json:"podType"`
Scale *Scale `json:"scale"`
TaggedUsers []TaggedUser `json:"taggedUsers"`
Key *common2.SlimKey `json:"key"`
Block *common2.SlimBlock `json:"block"`
// Boolean Attributes
Completed *bool `json:"completed"`
Archived *bool `json:"archived"`
KanbanMode *bool `json:"kanbanMode"`
CanUnlink *bool `json:"canUnlink"`
CanUnpublish bool `json:"canUnpublish"`
PublicKey *bool `json:"publicKey"`
// Time Attributes
DueDate string `json:"podDueDate"`
// Acl Attributes
Acl *string `json:"acl"`
CanLeave *bool `json:"canLeave"`
AllowDelete *bool `json:"allowDelete"`
CanDelete *bool `json:"canDelete"`
CurrentUserAcl SharedUser `json:"currentUserAcl"`
// Count Attributes
KeysCount *int `json:"keysCount"`
BlocksCount *int `json:"podsCount"`
TasksCount *int `json:"tasksCount"`
ChecklistsCount *int `json:"checklistsCount"`
AttachmentsCount *int `json:"attachmentsCount"`
CommentsCount *int `json:"commentsCount"`
NotesCount *int `json:"notesCount"`
Creator common2.ResourceCreator `json:"creator"`
Modifier common2.ResourceModifier `json:"modifier"`
LastModified string `json:"lastModified"`
}
type PodScaleValue ¶
type PodTemplate ¶
type PodTemplate struct {
ID string `json:"id"`
Name string `json:"templateName"`
Description string `json:"templateDescription"`
Color string `json:"color"`
Tags string `json:"tags"`
PreviewUrl string `json:"previewUrl"`
Archived bool `json:"archived"`
KeyTemplateId *string `json:"keyTemplateId"`
BlockTemplateId *string `json:"blockTemplateId"`
LastModified string `json:"lastModified"`
}
type PodTemplates ¶
type PodTemplates struct {
Templates []PodTemplate `json:"templates"`
}
type PodTypesKey ¶
type PodTypesKeys ¶
type PodTypesKeys struct {
Keys *[]PodTypesKey `json:"keys"`
Key *PodTypesKey `json:"key"`
}
type PodTypesKeysBlockPod ¶
type PodTypesKeysBlockPod struct {
BlockPod PodTypesKeys `json:"blockPod"`
}
type PodTypesKeysKeyPod ¶
type PodTypesKeysKeyPod struct {
KeyPod PodTypesKeys `json:"keyPod"`
}
type PodTypesKeysOtherPod ¶
type PodTypesKeysOtherPod struct {
OtherPod PodTypesKeys `json:"otherPod"`
}
type Preference ¶
type Profile ¶
type Profile struct {
ID string `json:"id"`
Email string `json:"email"`
Username string `json:"userName"`
FirstName string `json:"firstName"`
MiddleName string `json:"middleName"`
LastName string `json:"lastName"`
PhoneNumber string `json:"phoneNumber"`
AddressUserBy string `json:"addressUserBy"`
UserInitial string `json:"userInitial"`
AvatarName string `json:"avatarName"`
AvatarUrl string `json:"avatarUrl"`
IsInactive bool `json:"inactive"`
IsAnnualSubscriber bool `json:"isAnnualSubscriber"`
BlockedUsers []BlockedUser `json:"blockedUsers"`
Preferences []Preference `json:"preferences"`
}
type RecentComment ¶
type RecentComment struct {
ID string `json:"id"`
CommentText string `json:"commentText"`
Key *common2.SlimKey `json:"key"`
Block *common2.SlimBlock `json:"block"`
Blocks *[]common2.SlimBlock `json:"blocks"`
Pod *common2.SlimPod `json:"pod"`
StudentId *string `json:"studentId"`
Creator common2.ResourceCreator `json:"creator"`
Modifier common2.ResourceModifier `json:"modifier"`
LastModified string `json:"lastModified"`
}
type RecentComments ¶
type RecentComments struct {
Comments []RecentComment `json:"comments"`
}
type RecentlyModifiedKeys ¶
type RecentlyModifiedResources ¶
type RecentlyModifiedResources struct {
Blocks []DashboardBlock `json:"blocks"`
Pods []DashboardPod `json:"pods"`
}
type Relations ¶
type Relations struct {
Relationships Relationships `json:"relationships"`
}
type Relationships ¶
type ResourceAttribute ¶
type ResourceAttributes ¶
type ResourceAttributes struct {
KeyAttributes []ResourceAttribute
BlockAttributes []ResourceAttribute
PodAttributes []ResourceAttribute
}
type ScaleValues ¶
type ScaleValues struct {
Scale Scale `json:"scale"`
Key common2.SlimKey `json:"key"`
Block *common2.SlimBlock `json:"block"`
Blocks *[]BlockScaleValue `json:"blocks"`
Pods []PodScaleValue `json:"pods"`
}
type ScalesKeys ¶
type ScalesKeysBlock ¶
type ScalesKeysBlock struct {
Block ScalesKeys `json:"block"`
}
type ScalesKeysBlockPod ¶
type ScalesKeysBlockPod struct {
BlockPod ScalesKeys `json:"blockPod"`
}
type ScalesKeysKeyPod ¶
type ScalesKeysKeyPod struct {
KeyPod ScalesKeys `json:"keyPod"`
}
type ScalesKeysOtherPod ¶
type ScalesKeysOtherPod struct {
OtherPod ScalesKeys `json:"otherPod"`
}
type SchedulerEvent ¶
type SchedulerEvent struct {
SchedulerId string `json:"schedulerId"`
StandaloneEvents []StandaloneEvent `json:"standaloneEvents"`
}
type SearchResource ¶
type SearchResource struct {
ID string `json:"id"`
Type string `json:"type"`
// Relation attribute
IsRelated bool `json:"isRelated"`
KeyName *string `json:"keyName"`
KeyType *string `json:"keyType"`
BlockName *string `json:"blockName"`
PodName *string `json:"podName"`
Key *common2.SlimKey `json:"key"`
Block *common2.SlimBlock `json:"block"`
Blocks *[]common2.SlimBlock `json:"blocks"`
Modifier common2.ResourceModifier `json:"modifier"`
}
type SearchResources ¶
type SearchResources struct {
Results []SearchResource `json:"results"`
}
type SearchUser ¶
type SearchUsers ¶
type SearchUsers struct {
SearchUsers []SearchUser `json:"users"`
}
type SharedUser ¶
type SharedUser struct {
}
type StandaloneEvent ¶
type StandaloneEvent struct {
ID string `json:"id"`
Description string `json:"description"`
StartTime string `json:"eventStartTime"`
EndTime string `json:"eventEndTime"`
Creator *common2.ResourceCreator `json:"creator"`
Modifier *common2.ResourceModifier `json:"modifier"`
}
type TaggedUser ¶
type Task ¶
type Task struct {
ID string `json:"id"`
Name string `json:"taskName"`
DueDate string `json:"taskDueDate"`
Completed bool `json:"isCompleted"`
Assignees []TaggedUser `json:"assignees"`
Key *common2.SlimKey `json:"key"`
Block *common2.SlimBlock `json:"block"`
Creator common2.ResourceCreator `json:"creator"`
Modifier common2.ResourceModifier `json:"modifier"`
}
type TaskStatus ¶
type TasksEvent ¶
type TasksStatusBlock ¶
type TasksStatusKey ¶
type TasksStatusKey struct {
ID string `json:"id"`
Name string `json:"keyName"`
TaskStatus TaskStatus `json:"taskStatus"`
LastModified string `json:"lastModified"`
}
type TasksStatusKeys ¶
type TasksStatusKeys struct {
Keys []TasksStatusKey `json:"keys"`
}
type UpdateBlockScaleValue ¶
type UpdatePodScaleValue ¶
type UserRegistration ¶
type UserRegistration struct {
User User `json:"user"`
}
Source Files
¶
- attachment.struct.go
- attribute.struct.go
- block-type.struct.go
- block.struct.go
- chart.struct.go
- checklist.struct.go
- comment.struct.go
- conversation.struct.go
- dashboard.struct.go
- favorite.struct.go
- key.struct.go
- note.struct.go
- notification.struct.go
- pod-type.struct.go
- pod.struct.go
- profile.struct.go
- relation.struct.go
- scale.struct.go
- scheduler.struct.go
- task.struct.go
- template.struct.go
- user.struct.go
- version.struct.go
Click to show internal directories.
Click to hide internal directories.