Documentation
¶
Index ¶
- Constants
- Variables
- type Bookmark
- func (bookmark *Bookmark) GetBookmarkType() optional.Optional[string]
- func (bookmark *Bookmark) GetBookmarkTypeRef() *optional.Optional[string]
- func (bookmark *Bookmark) GetCreatedAt() time.Time
- func (bookmark *Bookmark) GetCreatedAtRef() *time.Time
- func (bookmark *Bookmark) GetDeletedAt() optional.Optional[time.Time]
- func (bookmark *Bookmark) GetDeletedAtRef() *optional.Optional[time.Time]
- func (bookmark *Bookmark) GetID() int64
- func (bookmark *Bookmark) GetIDRef() *int64
- func (bookmark *Bookmark) GetIsCollection() bool
- func (bookmark *Bookmark) GetIsCollectionRef() *bool
- func (bookmark *Bookmark) GetIsRead() bool
- func (bookmark *Bookmark) GetIsReadRef() *bool
- func (bookmark *Bookmark) GetTagIDs() []int64
- func (bookmark *Bookmark) GetTagIDsRef() *[]int64
- func (bookmark *Bookmark) GetTitle() optional.Optional[string]
- func (bookmark *Bookmark) GetTitleRef() *optional.Optional[string]
- func (bookmark *Bookmark) GetURL() string
- func (bookmark *Bookmark) GetURLRef() *string
- func (bookmark *Bookmark) GetUpdatedAt() time.Time
- func (bookmark *Bookmark) GetUpdatedAtRef() *time.Time
- func (t *Bookmark) IsDefault() bool
- type BookmarkField
- type BookmarkFilter
- type BookmarkUpdater
- type Document
- func (document *Document) GetBacklinkedDocumentsIDs() []int64
- func (document *Document) GetBacklinkedDocumentsIDsRef() *[]int64
- func (document *Document) GetCreatedAt() time.Time
- func (document *Document) GetCreatedAtRef() *time.Time
- func (document *Document) GetDeletedAt() optional.Optional[time.Time]
- func (document *Document) GetDeletedAtRef() *optional.Optional[time.Time]
- func (document *Document) GetDocumentType() optional.Optional[string]
- func (document *Document) GetDocumentTypeRef() *optional.Optional[string]
- func (document *Document) GetID() int64
- func (document *Document) GetIDRef() *int64
- func (document *Document) GetLinkedDocumentIDs() []int64
- func (document *Document) GetLinkedDocumentIDsRef() *[]int64
- func (document *Document) GetPath() string
- func (document *Document) GetPathRef() *string
- func (document *Document) GetTagIDs() []int64
- func (document *Document) GetTagIDsRef() *[]int64
- func (document *Document) GetUpdatedAt() time.Time
- func (document *Document) GetUpdatedAtRef() *time.Time
- func (t *Document) IsDefault() bool
- type DocumentField
- type DocumentFilter
- type DocumentUpdater
- type Tag
- func (tag *Tag) GetID() int64
- func (tag *Tag) GetIDRef() *int64
- func (tag *Tag) GetParentPathIDs() []int64
- func (tag *Tag) GetParentPathIDsRef() *[]int64
- func (tag *Tag) GetSubtagIDs() []int64
- func (tag *Tag) GetSubtagIDsRef() *[]int64
- func (tag *Tag) GetTag() string
- func (tag *Tag) GetTagRef() *string
- func (t *Tag) IsDefault() bool
- type TagField
- type TagFilter
- type TagUpdater
Constants ¶
View Source
const ( BookmarkFilterUntitled = "BookmarkFilterUntitled" BookmarkFilterUntagged = "BookmarkFilterUntagged" BookmarkFilterInboxed = "BookmarkFilterInboxed" BookmarkFilterDeleted = "BookmarkFilterDeleted" )
View Source
const ( DocumentFilterUntagged = "DocumentFilterUntagged" DocumentFilterDeleted = "DocumentFilterDeleted" )
View Source
const ( TagFilterLeaf = "TagFilterLeaf" TagFilterRoot = "TagFilterRoot" )
Variables ¶
View Source
var BookmarkFields = struct { CreatedAt BookmarkField UpdatedAt BookmarkField DeletedAt BookmarkField URL BookmarkField Title BookmarkField TagIDs BookmarkField ID BookmarkField IsCollection BookmarkField IsRead BookmarkField BookmarkType BookmarkField }{ CreatedAt: "created_at", UpdatedAt: "updated_at", DeletedAt: "deleted_at", URL: "url", Title: "title", TagIDs: "tagIDs", ID: "id", IsCollection: "is_collection", IsRead: "is_read", BookmarkType: "bookmark_type", }
View Source
var BookmarkFieldsList = []BookmarkField{ BookmarkField("CreatedAt"), BookmarkField("UpdatedAt"), BookmarkField("DeletedAt"), BookmarkField("URL"), BookmarkField("Title"), BookmarkField("TagIDs"), BookmarkField("ID"), BookmarkField("IsCollection"), BookmarkField("IsRead"), BookmarkField("BookmarkType"), }
View Source
var DocumentFields = struct { CreatedAt DocumentField UpdatedAt DocumentField DeletedAt DocumentField Path DocumentField DocumentType DocumentField TagIDs DocumentField LinkedDocumentIDs DocumentField BacklinkedDocumentsIDs DocumentField ID DocumentField }{ CreatedAt: "created_at", UpdatedAt: "updated_at", DeletedAt: "deleted_at", Path: "path", DocumentType: "document_type", TagIDs: "tagIDs", LinkedDocumentIDs: "linked_documentIDs", BacklinkedDocumentsIDs: "backlinked_documentIDs", ID: "id", }
View Source
var PredefinedBookmarkFilters = map[string]*BookmarkFilter{ BookmarkFilterUntitled: {Title: optional.Make(model.FilterOperation[optional.Optional[string]]{ Operand: model.ScalarOperand[optional.Optional[string]]{ Operand: optional.Optional[string]{}, }, Operator: model.FilterEqual, })}, BookmarkFilterUntagged: {TagIDs: optional.Make(model.FilterOperation[int64]{ Operand: model.ScalarOperand[int64]{ Operand: -1, }, Operator: model.FilterEqual, })}, BookmarkFilterInboxed: { Title: optional.Make(model.FilterOperation[optional.Optional[string]]{ Operand: model.ScalarOperand[optional.Optional[string]]{ Operand: optional.Optional[string]{}, }, Operator: model.FilterEqual, }), TagIDs: optional.Make(model.FilterOperation[int64]{ Operand: model.ScalarOperand[int64]{ Operand: -1, }, Operator: model.FilterEqual, })}, BookmarkFilterDeleted: {DeletedAt: optional.Make(model.FilterOperation[optional.Optional[time.Time]]{ Operand: model.ScalarOperand[optional.Optional[time.Time]]{ Operand: optional.Optional[time.Time]{}, }, Operator: model.FilterEqual, })}, }
View Source
var PredefinedDocumentFilters = map[string]*DocumentFilter{ DocumentFilterUntagged: {TagIDs: optional.Make(model.FilterOperation[int64]{ Operand: model.ScalarOperand[int64]{ Operand: -1, }, Operator: model.FilterEqual, })}, DocumentFilterDeleted: {DeletedAt: optional.Make(model.FilterOperation[optional.Optional[time.Time]]{ Operand: model.ScalarOperand[optional.Optional[time.Time]]{ Operand: optional.Optional[time.Time]{}, }, Operator: model.FilterEqual, })}, }
FIX: This operating on int64s instead of the slice is nonsense, right?
View Source
var PredefinedTagFilters = map[string]*TagFilter{ TagFilterLeaf: {ParentPathIDs: optional.Make(model.FilterOperation[int64]{ Operand: model.ScalarOperand[int64]{ Operand: -1, }, Operator: model.FilterEqual, })}, TagFilterRoot: {SubtagIDs: optional.Make(model.FilterOperation[int64]{ Operand: model.ScalarOperand[int64]{ Operand: -1, }, Operator: model.FilterEqual, })}, }
Functions ¶
This section is empty.
Types ¶
type Bookmark ¶
type Bookmark struct { CreatedAt time.Time `json:"created_at" toml:"created_at" yaml:"created_at"` UpdatedAt time.Time `json:"updated_at" toml:"updated_at" yaml:"updated_at"` DeletedAt optional.Optional[time.Time] `json:"deleted_at,omitempty" toml:"deleted_at" yaml:"deleted_at,omitempty"` URL string `json:"url" toml:"url" yaml:"url"` Title optional.Optional[string] `json:"title,omitempty" toml:"title" yaml:"title,omitempty"` TagIDs []int64 `json:"tagIDs" toml:"tagIDs" yaml:"tagIDs"` ID int64 `json:"id" toml:"id" yaml:"id"` IsCollection bool `json:"is_collection,omitempty" toml:"is_collection" yaml:"is_collection,omitempty"` IsRead bool `json:"is_read,omitempty" toml:"is_read" yaml:"is_read,omitempty"` BookmarkType optional.Optional[string] `json:"bookmark_type,omitempty" toml:"bookmark_type" yaml:"bookmark_type,omitempty"` }
func (*Bookmark) GetBookmarkType ¶ added in v0.6.0
func (*Bookmark) GetBookmarkTypeRef ¶ added in v0.6.0
func (*Bookmark) GetCreatedAt ¶ added in v0.6.0
func (*Bookmark) GetCreatedAtRef ¶ added in v0.6.0
func (*Bookmark) GetDeletedAt ¶ added in v0.6.0
func (*Bookmark) GetDeletedAtRef ¶ added in v0.6.0
func (*Bookmark) GetIsCollection ¶ added in v0.6.0
func (*Bookmark) GetIsCollectionRef ¶ added in v0.6.0
func (*Bookmark) GetIsReadRef ¶ added in v0.6.0
func (*Bookmark) GetTagIDsRef ¶ added in v0.6.0
func (*Bookmark) GetTitleRef ¶ added in v0.6.0
func (*Bookmark) GetUpdatedAt ¶ added in v0.6.0
func (*Bookmark) GetUpdatedAtRef ¶ added in v0.6.0
type BookmarkField ¶
type BookmarkField string
type BookmarkFilter ¶
type BookmarkFilter struct { CreatedAt optional.Optional[model.FilterOperation[time.Time]] `json:"createdAt,omitempty" toml:"createdAt,omitempty" yaml:"createdAt,omitempty"` UpdatedAt optional.Optional[model.FilterOperation[time.Time]] `json:"updatedAt,omitempty" toml:"updatedAt,omitempty" yaml:"updatedAt,omitempty"` DeletedAt optional.Optional[model.FilterOperation[optional.Optional[time.Time]]] `json:"deletedAt,omitempty" toml:"deletedAt,omitempty" yaml:"deletedAt,omitempty"` URL optional.Optional[model.FilterOperation[string]] `json:"uRL,omitempty" toml:"uRL,omitempty" yaml:"uRL,omitempty"` Title optional.Optional[model.FilterOperation[optional.Optional[string]]] `json:"title,omitempty" toml:"title,omitempty" yaml:"title,omitempty"` TagIDs optional.Optional[model.FilterOperation[int64]] `json:"tagIDs,omitempty" toml:"tagIDs,omitempty" yaml:"tagIDs,omitempty"` ID optional.Optional[model.FilterOperation[int64]] `json:"id,omitempty" toml:"id,omitempty" yaml:"id,omitempty"` IsCollection optional.Optional[model.FilterOperation[bool]] `json:"isCollection,omitempty" toml:"isCollection,omitempty" yaml:"isCollection,omitempty"` IsRead optional.Optional[model.FilterOperation[bool]] `json:"isRead,omitempty" toml:"isRead,omitempty" yaml:"isRead,omitempty"` BookmarkType optional.Optional[model.FilterOperation[optional.Optional[string]]] `json:"bookmarkType,omitempty" toml:"bookmarkType,omitempty" yaml:"bookmarkType,omitempty"` }
func (*BookmarkFilter) IsDefault ¶ added in v0.6.0
func (filter *BookmarkFilter) IsDefault() bool
type BookmarkUpdater ¶
type BookmarkUpdater struct { CreatedAt optional.Optional[model.UpdateOperation[time.Time]] `json:"createdAt,omitempty" toml:"createdAt,omitempty" yaml:"createdAt,omitempty"` UpdatedAt optional.Optional[model.UpdateOperation[time.Time]] `json:"updatedAt,omitempty" toml:"updatedAt,omitempty" yaml:"updatedAt,omitempty"` DeletedAt optional.Optional[model.UpdateOperation[optional.Optional[time.Time]]] `json:"deletedAt,omitempty" toml:"deletedAt,omitempty" yaml:"deletedAt,omitempty"` URL optional.Optional[model.UpdateOperation[string]] `json:"uRL,omitempty" toml:"uRL,omitempty" yaml:"uRL,omitempty"` Title optional.Optional[model.UpdateOperation[optional.Optional[string]]] `json:"title,omitempty" toml:"title,omitempty" yaml:"title,omitempty"` TagIDs optional.Optional[model.UpdateOperation[[]int64]] `json:"tagIDs,omitempty" toml:"tagIDs,omitempty" yaml:"tagIDs,omitempty"` ID optional.Optional[model.UpdateOperation[int64]] `json:"id,omitempty" toml:"id,omitempty" yaml:"id,omitempty"` IsCollection optional.Optional[model.UpdateOperation[bool]] `json:"isCollection,omitempty" toml:"isCollection,omitempty" yaml:"isCollection,omitempty"` IsRead optional.Optional[model.UpdateOperation[bool]] `json:"isRead,omitempty" toml:"isRead,omitempty" yaml:"isRead,omitempty"` BookmarkType optional.Optional[model.UpdateOperation[optional.Optional[string]]] `json:"bookmarkType,omitempty" toml:"bookmarkType,omitempty" yaml:"bookmarkType,omitempty"` }
func (*BookmarkUpdater) IsDefault ¶ added in v0.6.0
func (updater *BookmarkUpdater) IsDefault() bool
type Document ¶
type Document struct { CreatedAt time.Time `json:"created_at" toml:"created_at" yaml:"created_at"` UpdatedAt time.Time `json:"updated_at" toml:"updated_at" yaml:"updated_at"` DeletedAt optional.Optional[time.Time] `json:"deleted_at,omitempty" toml:"deleted_at" yaml:"deleted_at,omitempty"` Path string `json:"path" toml:"path" yaml:"path"` DocumentType optional.Optional[string] `json:"document_type" toml:"document_type" yaml:"document_type"` TagIDs []int64 `json:"tagIDs" toml:"tagIDs" yaml:"tagIDs"` LinkedDocumentIDs []int64 `json:"linked_documentIDs" toml:"linked_documentIDs" yaml:"linked_documentIDs"` BacklinkedDocumentsIDs []int64 `json:"backlinked_documentIDs" toml:"backlinked_documentIDs" yaml:"backlinked_documentIDs"` ID int64 `json:"id" toml:"id" yaml:"id"` }
func (*Document) GetBacklinkedDocumentsIDs ¶ added in v0.6.0
func (*Document) GetBacklinkedDocumentsIDsRef ¶ added in v0.6.0
func (*Document) GetCreatedAt ¶ added in v0.6.0
func (*Document) GetCreatedAtRef ¶ added in v0.6.0
func (*Document) GetDeletedAt ¶ added in v0.6.0
func (*Document) GetDeletedAtRef ¶ added in v0.6.0
func (*Document) GetDocumentType ¶ added in v0.6.0
func (*Document) GetDocumentTypeRef ¶ added in v0.6.0
func (*Document) GetLinkedDocumentIDs ¶ added in v0.6.0
func (*Document) GetLinkedDocumentIDsRef ¶ added in v0.6.0
func (*Document) GetPathRef ¶ added in v0.6.0
func (*Document) GetTagIDsRef ¶ added in v0.6.0
func (*Document) GetUpdatedAt ¶ added in v0.6.0
func (*Document) GetUpdatedAtRef ¶ added in v0.6.0
type DocumentField ¶
type DocumentField string
type DocumentFilter ¶
type DocumentFilter struct { CreatedAt optional.Optional[model.FilterOperation[time.Time]] `json:"createdAt,omitempty" toml:"createdAt,omitempty" yaml:"createdAt,omitempty"` UpdatedAt optional.Optional[model.FilterOperation[time.Time]] `json:"updatedAt,omitempty" toml:"updatedAt,omitempty" yaml:"updatedAt,omitempty"` DeletedAt optional.Optional[model.FilterOperation[optional.Optional[time.Time]]] `json:"deletedAt,omitempty" toml:"deletedAt,omitempty" yaml:"deletedAt,omitempty"` Path optional.Optional[model.FilterOperation[string]] `json:"path,omitempty" toml:"path,omitempty" yaml:"path,omitempty"` DocumentType optional.Optional[model.FilterOperation[optional.Optional[string]]] `json:"documentType,omitempty" toml:"documentType,omitempty" yaml:"documentType,omitempty"` TagIDs optional.Optional[model.FilterOperation[int64]] `json:"tagIDs,omitempty" toml:"tagIDs,omitempty" yaml:"tagIDs,omitempty"` LinkedDocumentIDs optional.Optional[model.FilterOperation[int64]] `json:"linkedDocumentIDs,omitempty" toml:"linkedDocumentIDs,omitempty" yaml:"linkedDocumentIDs,omitempty"` BacklinkedDocumentsIDs optional.Optional[model.FilterOperation[int64]] `json:"backlinkedDocumentsIDs,omitempty" toml:"backlinkedDocumentsIDs,omitempty" yaml:"backlinkedDocumentsIDs,omitempty"` ID optional.Optional[model.FilterOperation[int64]] `json:"id,omitempty" toml:"id,omitempty" yaml:"id,omitempty"` }
func (*DocumentFilter) IsDefault ¶ added in v0.6.0
func (filter *DocumentFilter) IsDefault() bool
type DocumentUpdater ¶
type DocumentUpdater struct { CreatedAt optional.Optional[model.UpdateOperation[time.Time]] `json:"createdAt,omitempty" toml:"createdAt,omitempty" yaml:"createdAt,omitempty"` UpdatedAt optional.Optional[model.UpdateOperation[time.Time]] `json:"updatedAt,omitempty" toml:"updatedAt,omitempty" yaml:"updatedAt,omitempty"` DeletedAt optional.Optional[model.UpdateOperation[optional.Optional[time.Time]]] `json:"deletedAt,omitempty" toml:"deletedAt,omitempty" yaml:"deletedAt,omitempty"` Path optional.Optional[model.UpdateOperation[string]] `json:"path,omitempty" toml:"path,omitempty" yaml:"path,omitempty"` DocumentType optional.Optional[model.UpdateOperation[optional.Optional[string]]] `json:"documentType,omitempty" toml:"documentType,omitempty" yaml:"documentType,omitempty"` TagIDs optional.Optional[model.UpdateOperation[[]int64]] `json:"tagIDs,omitempty" toml:"tagIDs,omitempty" yaml:"tagIDs,omitempty"` LinkedDocumentIDs optional.Optional[model.UpdateOperation[[]int64]] `json:"linkedDocumentIDs,omitempty" toml:"linkedDocumentIDs,omitempty" yaml:"linkedDocumentIDs,omitempty"` BacklinkedDocumentsIDs optional.Optional[model.UpdateOperation[[]int64]] `json:"backlinkedDocumentsIDs,omitempty" toml:"backlinkedDocumentsIDs,omitempty" yaml:"backlinkedDocumentsIDs,omitempty"` ID optional.Optional[model.UpdateOperation[int64]] `json:"id,omitempty" toml:"id,omitempty" yaml:"id,omitempty"` }
func (*DocumentUpdater) IsDefault ¶ added in v0.6.0
func (updater *DocumentUpdater) IsDefault() bool
type Tag ¶
type Tag struct { ID int64 `json:"id" toml:"id" yaml:"id"` ParentPathIDs []int64 `json:"parentPathIDs" toml:"parentPathIDs" yaml:"parentPathIDs"` Tag string `json:"tag" toml:"tag" yaml:"tag"` SubtagIDs []int64 `json:"subtagsIDs" toml:"subtagsIDs" yaml:"subtagsIDs"` }
func (*Tag) GetParentPathIDs ¶ added in v0.6.0
func (*Tag) GetParentPathIDsRef ¶ added in v0.6.0
func (*Tag) GetSubtagIDs ¶ added in v0.6.0
func (*Tag) GetSubtagIDsRef ¶ added in v0.6.0
type TagFilter ¶
type TagFilter struct { ID optional.Optional[model.FilterOperation[int64]] `json:"id,omitempty" toml:"id,omitempty" yaml:"id,omitempty"` ParentPathIDs optional.Optional[model.FilterOperation[int64]] `json:"parentPathIDs,omitempty" toml:"parentPathIDs,omitempty" yaml:"parentPathIDs,omitempty"` Tag optional.Optional[model.FilterOperation[string]] `json:"tag,omitempty" toml:"tag,omitempty" yaml:"tag,omitempty"` SubtagIDs optional.Optional[model.FilterOperation[int64]] `json:"subtagIDs,omitempty" toml:"subtagIDs,omitempty" yaml:"subtagIDs,omitempty"` }
type TagUpdater ¶
type TagUpdater struct { ID optional.Optional[model.UpdateOperation[int64]] `json:"id,omitempty" toml:"id,omitempty" yaml:"id,omitempty"` ParentPathIDs optional.Optional[model.UpdateOperation[[]int64]] `json:"parentPathIDs,omitempty" toml:"parentPathIDs,omitempty" yaml:"parentPathIDs,omitempty"` Tag optional.Optional[model.UpdateOperation[string]] `json:"tag,omitempty" toml:"tag,omitempty" yaml:"tag,omitempty"` SubtagIDs optional.Optional[model.UpdateOperation[[]int64]] `json:"subtagIDs,omitempty" toml:"subtagIDs,omitempty" yaml:"subtagIDs,omitempty"` }
func (*TagUpdater) IsDefault ¶ added in v0.6.0
func (updater *TagUpdater) IsDefault() bool
Click to show internal directories.
Click to hide internal directories.