Documentation ¶
Index ¶
- Variables
- type AuthenticateToSharedNoteArgs
- type AuthenticateToSharedNoteResult
- type AuthenticateToSharedNotebookArgs
- type AuthenticateToSharedNotebookResult
- type ClientUsageMetrics
- type CopyNoteArgs
- type CopyNoteResult
- type CreateLinkedNotebookArgs
- type CreateLinkedNotebookResult
- type CreateNoteArgs
- type CreateNoteResult
- type CreateNotebookArgs
- type CreateNotebookResult
- type CreateSearchArgs
- type CreateSearchResult
- type CreateSharedNotebookArgs
- type CreateSharedNotebookResult
- type CreateTagArgs
- type CreateTagResult
- type DeleteNoteArgs
- type DeleteNoteResult
- type EmailNoteArgs
- type EmailNoteResult
- type ExpungeInactiveNotesArgs
- type ExpungeInactiveNotesResult
- type ExpungeLinkedNotebookArgs
- type ExpungeLinkedNotebookResult
- type ExpungeNoteArgs
- type ExpungeNoteResult
- type ExpungeNotebookArgs
- type ExpungeNotebookResult
- type ExpungeNotesArgs
- type ExpungeNotesResult
- type ExpungeSearchArgs
- type ExpungeSearchResult
- type ExpungeSharedNotebooksArgs
- type ExpungeSharedNotebooksResult
- type ExpungeTagArgs
- type ExpungeTagResult
- type FindNoteCountsArgs
- type FindNoteCountsResult
- type FindNoteOffsetArgs
- type FindNoteOffsetResult
- type FindNotesArgs
- type FindNotesMetadataArgs
- type FindNotesMetadataResult
- type FindNotesResult
- type FindRelatedArgs
- type FindRelatedResult
- type GetDefaultNotebookArgs
- type GetDefaultNotebookResult
- type GetFilteredSyncChunkArgs
- type GetFilteredSyncChunkResult
- type GetLinkedNotebookSyncChunkArgs
- type GetLinkedNotebookSyncChunkResult
- type GetLinkedNotebookSyncStateArgs
- type GetLinkedNotebookSyncStateResult
- type GetNoteApplicationDataArgs
- type GetNoteApplicationDataEntryArgs
- type GetNoteApplicationDataEntryResult
- type GetNoteApplicationDataResult
- type GetNoteArgs
- type GetNoteContentArgs
- type GetNoteContentResult
- type GetNoteResult
- type GetNoteSearchTextArgs
- type GetNoteSearchTextResult
- type GetNoteTagNamesArgs
- type GetNoteTagNamesResult
- type GetNoteVersionArgs
- type GetNoteVersionResult
- type GetNotebookArgs
- type GetNotebookResult
- type GetPublicNotebookArgs
- type GetPublicNotebookResult
- type GetResourceAlternateDataArgs
- type GetResourceAlternateDataResult
- type GetResourceApplicationDataArgs
- type GetResourceApplicationDataEntryArgs
- type GetResourceApplicationDataEntryResult
- type GetResourceApplicationDataResult
- type GetResourceArgs
- type GetResourceAttributesArgs
- type GetResourceAttributesResult
- type GetResourceByHashArgs
- type GetResourceByHashResult
- type GetResourceDataArgs
- type GetResourceDataResult
- type GetResourceRecognitionArgs
- type GetResourceRecognitionResult
- type GetResourceResult
- type GetResourceSearchTextArgs
- type GetResourceSearchTextResult
- type GetSearchArgs
- type GetSearchResult
- type GetSharedNotebookByAuthArgs
- type GetSharedNotebookByAuthResult
- type GetSyncChunkArgs
- type GetSyncChunkResult
- type GetSyncStateArgs
- type GetSyncStateResult
- type GetSyncStateWithMetricsArgs
- type GetSyncStateWithMetricsResult
- type GetTagArgs
- type GetTagResult
- type ListLinkedNotebooksArgs
- type ListLinkedNotebooksResult
- type ListNoteVersionsArgs
- type ListNoteVersionsResult
- type ListNotebooksArgs
- type ListNotebooksResult
- type ListSearchesArgs
- type ListSearchesResult
- type ListSharedNotebooksArgs
- type ListSharedNotebooksResult
- type ListTagsArgs
- type ListTagsByNotebookArgs
- type ListTagsByNotebookResult
- type ListTagsResult
- type NoteCollectionCounts
- func (p *NoteCollectionCounts) IsSetNotebookCounts() bool
- func (p *NoteCollectionCounts) IsSetTagCounts() bool
- func (p *NoteCollectionCounts) IsSetTrashCount() bool
- func (p *NoteCollectionCounts) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *NoteCollectionCounts) String() string
- func (p *NoteCollectionCounts) Write(ctx context.Context, oprot thrift.TProtocol) error
- type NoteEmailParameters
- func (p *NoteEmailParameters) IsSetCcAddresses() bool
- func (p *NoteEmailParameters) IsSetGuid() bool
- func (p *NoteEmailParameters) IsSetMessage() bool
- func (p *NoteEmailParameters) IsSetNote() bool
- func (p *NoteEmailParameters) IsSetSubject() bool
- func (p *NoteEmailParameters) IsSetToAddresses() bool
- func (p *NoteEmailParameters) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *NoteEmailParameters) String() string
- func (p *NoteEmailParameters) Write(ctx context.Context, oprot thrift.TProtocol) error
- type NoteFilter
- func (p *NoteFilter) IsSetAscending() bool
- func (p *NoteFilter) IsSetEmphasized() bool
- func (p *NoteFilter) IsSetInactive() bool
- func (p *NoteFilter) IsSetNotebookGuid() bool
- func (p *NoteFilter) IsSetOrder() bool
- func (p *NoteFilter) IsSetTagGuids() bool
- func (p *NoteFilter) IsSetTimeZone() bool
- func (p *NoteFilter) IsSetWords() bool
- func (p *NoteFilter) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *NoteFilter) String() string
- func (p *NoteFilter) Write(ctx context.Context, oprot thrift.TProtocol) error
- type NoteList
- func (p *NoteList) IsSetSearchedWords() bool
- func (p *NoteList) IsSetStoppedWords() bool
- func (p *NoteList) IsSetUpdateCount() bool
- func (p *NoteList) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *NoteList) String() string
- func (p *NoteList) Write(ctx context.Context, oprot thrift.TProtocol) error
- type NoteMetadata
- func (p *NoteMetadata) IsSetAttributes() bool
- func (p *NoteMetadata) IsSetContentLength() bool
- func (p *NoteMetadata) IsSetCreated() bool
- func (p *NoteMetadata) IsSetDeleted() bool
- func (p *NoteMetadata) IsSetLargestResourceMime() bool
- func (p *NoteMetadata) IsSetLargestResourceSize() bool
- func (p *NoteMetadata) IsSetNotebookGuid() bool
- func (p *NoteMetadata) IsSetTagGuids() bool
- func (p *NoteMetadata) IsSetTitle() bool
- func (p *NoteMetadata) IsSetUpdateSequenceNum() bool
- func (p *NoteMetadata) IsSetUpdated() bool
- func (p *NoteMetadata) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *NoteMetadata) String() string
- func (p *NoteMetadata) Write(ctx context.Context, oprot thrift.TProtocol) error
- type NoteStore
- type NoteStoreClient
- func (p *NoteStoreClient) AuthenticateToSharedNote(ctx context.Context, guid string, noteKey string, authenticationToken string) (r *UserStore.AuthenticationResult, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) AuthenticateToSharedNotebook(ctx context.Context, shareKey string, authenticationToken string) (r *UserStore.AuthenticationResult, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) CopyNote(ctx context.Context, authenticationToken string, noteGuid Types.Guid, ...) (r *Types.Note, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) CreateLinkedNotebook(ctx context.Context, authenticationToken string, ...) (r *Types.LinkedNotebook, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) CreateNote(ctx context.Context, authenticationToken string, note *Types.Note) (r *Types.Note, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) CreateNotebook(ctx context.Context, authenticationToken string, notebook *Types.Notebook) (r *Types.Notebook, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) CreateSearch(ctx context.Context, authenticationToken string, search *Types.SavedSearch) (r *Types.SavedSearch, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) CreateSharedNotebook(ctx context.Context, authenticationToken string, ...) (r *Types.SharedNotebook, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) CreateTag(ctx context.Context, authenticationToken string, tag *Types.Tag) (r *Types.Tag, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) DeleteNote(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) EmailNote(ctx context.Context, authenticationToken string, ...) (userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ExpungeInactiveNotes(ctx context.Context, authenticationToken string) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ExpungeLinkedNotebook(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ExpungeNote(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ExpungeNotebook(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ExpungeNotes(ctx context.Context, authenticationToken string, noteGuids []Types.Guid) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ExpungeSearch(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ExpungeSharedNotebooks(ctx context.Context, authenticationToken string, sharedNotebookIds []int64) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ExpungeTag(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) FindNoteCounts(ctx context.Context, authenticationToken string, filter *NoteFilter, ...) (r *NoteCollectionCounts, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) FindNoteOffset(ctx context.Context, authenticationToken string, filter *NoteFilter, ...) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) FindNotes(ctx context.Context, authenticationToken string, filter *NoteFilter, ...) (r *NoteList, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) FindNotesMetadata(ctx context.Context, authenticationToken string, filter *NoteFilter, ...) (r *NotesMetadataList, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) FindRelated(ctx context.Context, authenticationToken string, query *RelatedQuery, ...) (r *RelatedResult, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetDefaultNotebook(ctx context.Context, authenticationToken string) (r *Types.Notebook, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetFilteredSyncChunk(ctx context.Context, authenticationToken string, afterUSN int32, ...) (r *SyncChunk, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetLinkedNotebookSyncChunk(ctx context.Context, authenticationToken string, ...) (r *SyncChunk, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetLinkedNotebookSyncState(ctx context.Context, authenticationToken string, ...) (r *SyncState, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetNote(ctx context.Context, authenticationToken string, guid Types.Guid, ...) (r *Types.Note, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetNoteApplicationData(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.LazyMap, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetNoteApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r string, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetNoteContent(ctx context.Context, authenticationToken string, guid Types.Guid) (r string, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetNoteSearchText(ctx context.Context, authenticationToken string, guid Types.Guid, ...) (r string, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetNoteTagNames(ctx context.Context, authenticationToken string, guid Types.Guid) (r []string, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetNoteVersion(ctx context.Context, authenticationToken string, noteGuid Types.Guid, ...) (r *Types.Note, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetNotebook(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.Notebook, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetPublicNotebook(ctx context.Context, userId Types.UserID, publicUri string) (r *Types.Notebook, systemException *Errors.EDAMSystemException, ...)
- func (p *NoteStoreClient) GetResource(ctx context.Context, authenticationToken string, guid Types.Guid, ...) (r *Types.Resource, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetResourceAlternateData(ctx context.Context, authenticationToken string, guid Types.Guid) (r []byte, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetResourceApplicationData(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.LazyMap, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetResourceApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r string, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetResourceAttributes(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.ResourceAttributes, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetResourceByHash(ctx context.Context, authenticationToken string, noteGuid Types.Guid, ...) (r *Types.Resource, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetResourceData(ctx context.Context, authenticationToken string, guid Types.Guid) (r []byte, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetResourceRecognition(ctx context.Context, authenticationToken string, guid Types.Guid) (r []byte, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetResourceSearchText(ctx context.Context, authenticationToken string, guid Types.Guid) (r string, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetSearch(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.SavedSearch, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetSharedNotebookByAuth(ctx context.Context, authenticationToken string) (r *Types.SharedNotebook, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetSyncChunk(ctx context.Context, authenticationToken string, afterUSN int32, ...) (r *SyncChunk, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetSyncState(ctx context.Context, authenticationToken string) (r *SyncState, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetSyncStateWithMetrics(ctx context.Context, authenticationToken string, ...) (r *SyncState, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) GetTag(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.Tag, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ListLinkedNotebooks(ctx context.Context, authenticationToken string) (r []*Types.LinkedNotebook, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ListNoteVersions(ctx context.Context, authenticationToken string, noteGuid Types.Guid) (r []*NoteVersionId, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ListNotebooks(ctx context.Context, authenticationToken string) (r []*Types.Notebook, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ListSearches(ctx context.Context, authenticationToken string) (r []*Types.SavedSearch, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ListSharedNotebooks(ctx context.Context, authenticationToken string) (r []*Types.SharedNotebook, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ListTags(ctx context.Context, authenticationToken string) (r []*Types.Tag, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ListTagsByNotebook(ctx context.Context, authenticationToken string, notebookGuid Types.Guid) (r []*Types.Tag, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) SendMessageToSharedNotebookMembers(ctx context.Context, authenticationToken string, notebookGuid Types.Guid, ...) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) SetNoteApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string, ...) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) SetResourceApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string, ...) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) SetSharedNotebookRecipientSettings(ctx context.Context, authenticationToken string, sharedNotebookId int64, ...) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) ShareNote(ctx context.Context, authenticationToken string, guid Types.Guid) (r string, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) StopSharingNote(ctx context.Context, authenticationToken string, guid Types.Guid) (userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UnsetNoteApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UnsetResourceApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UntagAll(ctx context.Context, authenticationToken string, guid Types.Guid) (userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UpdateLinkedNotebook(ctx context.Context, authenticationToken string, ...) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UpdateNote(ctx context.Context, authenticationToken string, note *Types.Note) (r *Types.Note, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UpdateNotebook(ctx context.Context, authenticationToken string, notebook *Types.Notebook) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UpdateResource(ctx context.Context, authenticationToken string, resource *Types.Resource) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UpdateSearch(ctx context.Context, authenticationToken string, search *Types.SavedSearch) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UpdateSharedNotebook(ctx context.Context, authenticationToken string, ...) (r int32, userException *Errors.EDAMUserException, ...)
- func (p *NoteStoreClient) UpdateTag(ctx context.Context, authenticationToken string, tag *Types.Tag) (r int32, userException *Errors.EDAMUserException, ...)
- type NoteStoreProcessor
- func (p *NoteStoreProcessor) AddToProcessorMap(key string, processor thrift.TProcessorFunction)
- func (p *NoteStoreProcessor) GetProcessorFunction(key string) (processor thrift.TProcessorFunction, ok bool)
- func (p *NoteStoreProcessor) Process(ctx context.Context, iprot, oprot thrift.TProtocol) (success bool, exp thrift.TException)
- func (p *NoteStoreProcessor) ProcessorMap() map[string]thrift.TProcessorFunction
- type NoteVersionId
- type NotesMetadataList
- func (p *NotesMetadataList) IsSetSearchedWords() bool
- func (p *NotesMetadataList) IsSetStoppedWords() bool
- func (p *NotesMetadataList) IsSetUpdateCount() bool
- func (p *NotesMetadataList) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *NotesMetadataList) String() string
- func (p *NotesMetadataList) Write(ctx context.Context, oprot thrift.TProtocol) error
- type NotesMetadataResultSpec
- func (p *NotesMetadataResultSpec) IsSetIncludeAttributes() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeContentLength() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeCreated() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeDeleted() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeLargestResourceMime() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeLargestResourceSize() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeNotebookGuid() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeTagGuids() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeTitle() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeUpdateSequenceNum() bool
- func (p *NotesMetadataResultSpec) IsSetIncludeUpdated() bool
- func (p *NotesMetadataResultSpec) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *NotesMetadataResultSpec) String() string
- func (p *NotesMetadataResultSpec) Write(ctx context.Context, oprot thrift.TProtocol) error
- type RelatedQuery
- func (p *RelatedQuery) IsSetFilter() bool
- func (p *RelatedQuery) IsSetNoteGuid() bool
- func (p *RelatedQuery) IsSetPlainText() bool
- func (p *RelatedQuery) IsSetReferenceUri() bool
- func (p *RelatedQuery) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *RelatedQuery) String() string
- func (p *RelatedQuery) Write(ctx context.Context, oprot thrift.TProtocol) error
- type RelatedResult
- func (p *RelatedResult) IsSetContainingNotebooks() bool
- func (p *RelatedResult) IsSetNotebooks() bool
- func (p *RelatedResult) IsSetNotes() bool
- func (p *RelatedResult) IsSetTags() bool
- func (p *RelatedResult) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *RelatedResult) String() string
- func (p *RelatedResult) Write(ctx context.Context, oprot thrift.TProtocol) error
- type RelatedResultSpec
- func (p *RelatedResultSpec) IsSetIncludeContainingNotebooks() bool
- func (p *RelatedResultSpec) IsSetMaxNotebooks() bool
- func (p *RelatedResultSpec) IsSetMaxNotes() bool
- func (p *RelatedResultSpec) IsSetMaxTags() bool
- func (p *RelatedResultSpec) IsSetWritableNotebooksOnly() bool
- func (p *RelatedResultSpec) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *RelatedResultSpec) String() string
- func (p *RelatedResultSpec) Write(ctx context.Context, oprot thrift.TProtocol) error
- type SendMessageToSharedNotebookMembersArgs
- type SendMessageToSharedNotebookMembersResult
- type SetNoteApplicationDataEntryArgs
- type SetNoteApplicationDataEntryResult
- type SetResourceApplicationDataEntryArgs
- type SetResourceApplicationDataEntryResult
- type SetSharedNotebookRecipientSettingsArgs
- type SetSharedNotebookRecipientSettingsResult
- type ShareNoteArgs
- type ShareNoteResult
- type StopSharingNoteArgs
- type StopSharingNoteResult
- type SyncChunk
- func (p *SyncChunk) IsSetChunkHighUSN() bool
- func (p *SyncChunk) IsSetExpungedLinkedNotebooks() bool
- func (p *SyncChunk) IsSetExpungedNotebooks() bool
- func (p *SyncChunk) IsSetExpungedNotes() bool
- func (p *SyncChunk) IsSetExpungedSearches() bool
- func (p *SyncChunk) IsSetExpungedTags() bool
- func (p *SyncChunk) IsSetLinkedNotebooks() bool
- func (p *SyncChunk) IsSetNotebooks() bool
- func (p *SyncChunk) IsSetNotes() bool
- func (p *SyncChunk) IsSetResources() bool
- func (p *SyncChunk) IsSetSearches() bool
- func (p *SyncChunk) IsSetTags() bool
- func (p *SyncChunk) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *SyncChunk) String() string
- func (p *SyncChunk) Write(ctx context.Context, oprot thrift.TProtocol) error
- type SyncChunkFilter
- func (p *SyncChunkFilter) IsSetIncludeExpunged() bool
- func (p *SyncChunkFilter) IsSetIncludeLinkedNotebooks() bool
- func (p *SyncChunkFilter) IsSetIncludeNoteApplicationDataFullMap() bool
- func (p *SyncChunkFilter) IsSetIncludeNoteAttributes() bool
- func (p *SyncChunkFilter) IsSetIncludeNoteResourceApplicationDataFullMap() bool
- func (p *SyncChunkFilter) IsSetIncludeNoteResources() bool
- func (p *SyncChunkFilter) IsSetIncludeNotebooks() bool
- func (p *SyncChunkFilter) IsSetIncludeNotes() bool
- func (p *SyncChunkFilter) IsSetIncludeResourceApplicationDataFullMap() bool
- func (p *SyncChunkFilter) IsSetIncludeResources() bool
- func (p *SyncChunkFilter) IsSetIncludeSearches() bool
- func (p *SyncChunkFilter) IsSetIncludeTags() bool
- func (p *SyncChunkFilter) IsSetRequireNoteContentClass() bool
- func (p *SyncChunkFilter) Read(ctx context.Context, iprot thrift.TProtocol) error
- func (p *SyncChunkFilter) String() string
- func (p *SyncChunkFilter) Write(ctx context.Context, oprot thrift.TProtocol) error
- type SyncState
- type UnsetNoteApplicationDataEntryArgs
- type UnsetNoteApplicationDataEntryResult
- type UnsetResourceApplicationDataEntryArgs
- type UnsetResourceApplicationDataEntryResult
- type UntagAllArgs
- type UntagAllResult
- type UpdateLinkedNotebookArgs
- type UpdateLinkedNotebookResult
- type UpdateNoteArgs
- type UpdateNoteResult
- type UpdateNotebookArgs
- type UpdateNotebookResult
- type UpdateResourceArgs
- type UpdateResourceResult
- type UpdateSearchArgs
- type UpdateSearchResult
- type UpdateSharedNotebookArgs
- type UpdateSharedNotebookResult
- type UpdateTagArgs
- type UpdateTagResult
Constants ¶
This section is empty.
Variables ¶
var GoUnusedProtection__ int
Functions ¶
This section is empty.
Types ¶
type AuthenticateToSharedNoteArgs ¶
type AuthenticateToSharedNoteArgs struct {}
func NewAuthenticateToSharedNoteArgs ¶
func NewAuthenticateToSharedNoteArgs() *AuthenticateToSharedNoteArgs
func (*AuthenticateToSharedNoteArgs) String ¶
func (p *AuthenticateToSharedNoteArgs) String() string
type AuthenticateToSharedNoteResult ¶
type AuthenticateToSharedNoteResult struct {}
func NewAuthenticateToSharedNoteResult ¶
func NewAuthenticateToSharedNoteResult() *AuthenticateToSharedNoteResult
func (*AuthenticateToSharedNoteResult) String ¶
func (p *AuthenticateToSharedNoteResult) String() string
type AuthenticateToSharedNotebookArgs ¶
type AuthenticateToSharedNotebookArgs struct {}
func NewAuthenticateToSharedNotebookArgs ¶
func NewAuthenticateToSharedNotebookArgs() *AuthenticateToSharedNotebookArgs
func (*AuthenticateToSharedNotebookArgs) String ¶
func (p *AuthenticateToSharedNotebookArgs) String() string
type AuthenticateToSharedNotebookResult ¶
type AuthenticateToSharedNotebookResult struct {}
func NewAuthenticateToSharedNotebookResult ¶
func NewAuthenticateToSharedNotebookResult() *AuthenticateToSharedNotebookResult
func (*AuthenticateToSharedNotebookResult) String ¶
func (p *AuthenticateToSharedNotebookResult) String() string
type ClientUsageMetrics ¶
type ClientUsageMetrics struct {
Sessions int32 `thrift:"sessions,1"`
}
func NewClientUsageMetrics ¶
func NewClientUsageMetrics() *ClientUsageMetrics
func (*ClientUsageMetrics) IsSetSessions ¶
func (p *ClientUsageMetrics) IsSetSessions() bool
func (*ClientUsageMetrics) String ¶
func (p *ClientUsageMetrics) String() string
type CopyNoteArgs ¶
type CopyNoteArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` NoteGuid Types.Guid `thrift:"noteGuid,2"` ToNotebookGuid Types.Guid `thrift:"toNotebookGuid,3"` }
func NewCopyNoteArgs ¶
func NewCopyNoteArgs() *CopyNoteArgs
func (*CopyNoteArgs) String ¶
func (p *CopyNoteArgs) String() string
type CopyNoteResult ¶
type CopyNoteResult struct { Success *Types.Note `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewCopyNoteResult ¶
func NewCopyNoteResult() *CopyNoteResult
func (*CopyNoteResult) String ¶
func (p *CopyNoteResult) String() string
type CreateLinkedNotebookArgs ¶
type CreateLinkedNotebookArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` LinkedNotebook *Types.LinkedNotebook `thrift:"linkedNotebook,2"` }
func NewCreateLinkedNotebookArgs ¶
func NewCreateLinkedNotebookArgs() *CreateLinkedNotebookArgs
func (*CreateLinkedNotebookArgs) String ¶
func (p *CreateLinkedNotebookArgs) String() string
type CreateLinkedNotebookResult ¶
type CreateLinkedNotebookResult struct { Success *Types.LinkedNotebook `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,2"` SystemException *Errors.EDAMSystemException `thrift:"systemException,3"` }
func NewCreateLinkedNotebookResult ¶
func NewCreateLinkedNotebookResult() *CreateLinkedNotebookResult
func (*CreateLinkedNotebookResult) String ¶
func (p *CreateLinkedNotebookResult) String() string
type CreateNoteArgs ¶
type CreateNoteArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Note *Types.Note `thrift:"note,2"` }
func NewCreateNoteArgs ¶
func NewCreateNoteArgs() *CreateNoteArgs
func (*CreateNoteArgs) String ¶
func (p *CreateNoteArgs) String() string
type CreateNoteResult ¶
type CreateNoteResult struct { Success *Types.Note `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewCreateNoteResult ¶
func NewCreateNoteResult() *CreateNoteResult
func (*CreateNoteResult) String ¶
func (p *CreateNoteResult) String() string
type CreateNotebookArgs ¶
type CreateNotebookArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Notebook *Types.Notebook `thrift:"notebook,2"` }
func NewCreateNotebookArgs ¶
func NewCreateNotebookArgs() *CreateNotebookArgs
func (*CreateNotebookArgs) String ¶
func (p *CreateNotebookArgs) String() string
type CreateNotebookResult ¶
type CreateNotebookResult struct { Success *Types.Notebook `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewCreateNotebookResult ¶
func NewCreateNotebookResult() *CreateNotebookResult
func (*CreateNotebookResult) String ¶
func (p *CreateNotebookResult) String() string
type CreateSearchArgs ¶
type CreateSearchArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Search *Types.SavedSearch `thrift:"search,2"` }
func NewCreateSearchArgs ¶
func NewCreateSearchArgs() *CreateSearchArgs
func (*CreateSearchArgs) String ¶
func (p *CreateSearchArgs) String() string
type CreateSearchResult ¶
type CreateSearchResult struct { Success *Types.SavedSearch `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewCreateSearchResult ¶
func NewCreateSearchResult() *CreateSearchResult
func (*CreateSearchResult) String ¶
func (p *CreateSearchResult) String() string
type CreateSharedNotebookArgs ¶
type CreateSharedNotebookArgs struct {}
func NewCreateSharedNotebookArgs ¶
func NewCreateSharedNotebookArgs() *CreateSharedNotebookArgs
func (*CreateSharedNotebookArgs) String ¶
func (p *CreateSharedNotebookArgs) String() string
type CreateSharedNotebookResult ¶
type CreateSharedNotebookResult struct {}
func NewCreateSharedNotebookResult ¶
func NewCreateSharedNotebookResult() *CreateSharedNotebookResult
func (*CreateSharedNotebookResult) String ¶
func (p *CreateSharedNotebookResult) String() string
type CreateTagArgs ¶
type CreateTagArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Tag *Types.Tag `thrift:"tag,2"` }
func NewCreateTagArgs ¶
func NewCreateTagArgs() *CreateTagArgs
func (*CreateTagArgs) String ¶
func (p *CreateTagArgs) String() string
type CreateTagResult ¶
type CreateTagResult struct { Success *Types.Tag `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewCreateTagResult ¶
func NewCreateTagResult() *CreateTagResult
func (*CreateTagResult) String ¶
func (p *CreateTagResult) String() string
type DeleteNoteArgs ¶
type DeleteNoteArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewDeleteNoteArgs ¶
func NewDeleteNoteArgs() *DeleteNoteArgs
func (*DeleteNoteArgs) String ¶
func (p *DeleteNoteArgs) String() string
type DeleteNoteResult ¶
type DeleteNoteResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewDeleteNoteResult ¶
func NewDeleteNoteResult() *DeleteNoteResult
func (*DeleteNoteResult) String ¶
func (p *DeleteNoteResult) String() string
type EmailNoteArgs ¶
type EmailNoteArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Parameters *NoteEmailParameters `thrift:"parameters,2"` }
func NewEmailNoteArgs ¶
func NewEmailNoteArgs() *EmailNoteArgs
func (*EmailNoteArgs) String ¶
func (p *EmailNoteArgs) String() string
type EmailNoteResult ¶
type EmailNoteResult struct { UserException *Errors.EDAMUserException `thrift:"userException,1"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,2"` SystemException *Errors.EDAMSystemException `thrift:"systemException,3"` }
func NewEmailNoteResult ¶
func NewEmailNoteResult() *EmailNoteResult
func (*EmailNoteResult) String ¶
func (p *EmailNoteResult) String() string
type ExpungeInactiveNotesArgs ¶
type ExpungeInactiveNotesArgs struct {
AuthenticationToken string `thrift:"authenticationToken,1"`
}
func NewExpungeInactiveNotesArgs ¶
func NewExpungeInactiveNotesArgs() *ExpungeInactiveNotesArgs
func (*ExpungeInactiveNotesArgs) String ¶
func (p *ExpungeInactiveNotesArgs) String() string
type ExpungeInactiveNotesResult ¶
type ExpungeInactiveNotesResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewExpungeInactiveNotesResult ¶
func NewExpungeInactiveNotesResult() *ExpungeInactiveNotesResult
func (*ExpungeInactiveNotesResult) String ¶
func (p *ExpungeInactiveNotesResult) String() string
type ExpungeLinkedNotebookArgs ¶
type ExpungeLinkedNotebookArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewExpungeLinkedNotebookArgs ¶
func NewExpungeLinkedNotebookArgs() *ExpungeLinkedNotebookArgs
func (*ExpungeLinkedNotebookArgs) String ¶
func (p *ExpungeLinkedNotebookArgs) String() string
type ExpungeLinkedNotebookResult ¶
type ExpungeLinkedNotebookResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,2"` SystemException *Errors.EDAMSystemException `thrift:"systemException,3"` }
func NewExpungeLinkedNotebookResult ¶
func NewExpungeLinkedNotebookResult() *ExpungeLinkedNotebookResult
func (*ExpungeLinkedNotebookResult) String ¶
func (p *ExpungeLinkedNotebookResult) String() string
type ExpungeNoteArgs ¶
type ExpungeNoteArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewExpungeNoteArgs ¶
func NewExpungeNoteArgs() *ExpungeNoteArgs
func (*ExpungeNoteArgs) String ¶
func (p *ExpungeNoteArgs) String() string
type ExpungeNoteResult ¶
type ExpungeNoteResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewExpungeNoteResult ¶
func NewExpungeNoteResult() *ExpungeNoteResult
func (*ExpungeNoteResult) String ¶
func (p *ExpungeNoteResult) String() string
type ExpungeNotebookArgs ¶
type ExpungeNotebookArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewExpungeNotebookArgs ¶
func NewExpungeNotebookArgs() *ExpungeNotebookArgs
func (*ExpungeNotebookArgs) String ¶
func (p *ExpungeNotebookArgs) String() string
type ExpungeNotebookResult ¶
type ExpungeNotebookResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewExpungeNotebookResult ¶
func NewExpungeNotebookResult() *ExpungeNotebookResult
func (*ExpungeNotebookResult) String ¶
func (p *ExpungeNotebookResult) String() string
type ExpungeNotesArgs ¶
type ExpungeNotesArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` NoteGuids []Types.Guid `thrift:"noteGuids,2"` }
func NewExpungeNotesArgs ¶
func NewExpungeNotesArgs() *ExpungeNotesArgs
func (*ExpungeNotesArgs) String ¶
func (p *ExpungeNotesArgs) String() string
type ExpungeNotesResult ¶
type ExpungeNotesResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewExpungeNotesResult ¶
func NewExpungeNotesResult() *ExpungeNotesResult
func (*ExpungeNotesResult) String ¶
func (p *ExpungeNotesResult) String() string
type ExpungeSearchArgs ¶
type ExpungeSearchArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewExpungeSearchArgs ¶
func NewExpungeSearchArgs() *ExpungeSearchArgs
func (*ExpungeSearchArgs) String ¶
func (p *ExpungeSearchArgs) String() string
type ExpungeSearchResult ¶
type ExpungeSearchResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewExpungeSearchResult ¶
func NewExpungeSearchResult() *ExpungeSearchResult
func (*ExpungeSearchResult) String ¶
func (p *ExpungeSearchResult) String() string
type ExpungeSharedNotebooksArgs ¶
type ExpungeSharedNotebooksArgs struct {}
func NewExpungeSharedNotebooksArgs ¶
func NewExpungeSharedNotebooksArgs() *ExpungeSharedNotebooksArgs
func (*ExpungeSharedNotebooksArgs) String ¶
func (p *ExpungeSharedNotebooksArgs) String() string
type ExpungeSharedNotebooksResult ¶
type ExpungeSharedNotebooksResult struct {}
func NewExpungeSharedNotebooksResult ¶
func NewExpungeSharedNotebooksResult() *ExpungeSharedNotebooksResult
func (*ExpungeSharedNotebooksResult) String ¶
func (p *ExpungeSharedNotebooksResult) String() string
type ExpungeTagArgs ¶
type ExpungeTagArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewExpungeTagArgs ¶
func NewExpungeTagArgs() *ExpungeTagArgs
func (*ExpungeTagArgs) String ¶
func (p *ExpungeTagArgs) String() string
type ExpungeTagResult ¶
type ExpungeTagResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewExpungeTagResult ¶
func NewExpungeTagResult() *ExpungeTagResult
func (*ExpungeTagResult) String ¶
func (p *ExpungeTagResult) String() string
type FindNoteCountsArgs ¶
type FindNoteCountsArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Filter *NoteFilter `thrift:"filter,2"` WithTrash bool `thrift:"withTrash,3"` }
func NewFindNoteCountsArgs ¶
func NewFindNoteCountsArgs() *FindNoteCountsArgs
func (*FindNoteCountsArgs) String ¶
func (p *FindNoteCountsArgs) String() string
type FindNoteCountsResult ¶
type FindNoteCountsResult struct { Success *NoteCollectionCounts `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewFindNoteCountsResult ¶
func NewFindNoteCountsResult() *FindNoteCountsResult
func (*FindNoteCountsResult) String ¶
func (p *FindNoteCountsResult) String() string
type FindNoteOffsetArgs ¶
type FindNoteOffsetArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Filter *NoteFilter `thrift:"filter,2"` Guid Types.Guid `thrift:"guid,3"` }
func NewFindNoteOffsetArgs ¶
func NewFindNoteOffsetArgs() *FindNoteOffsetArgs
func (*FindNoteOffsetArgs) String ¶
func (p *FindNoteOffsetArgs) String() string
type FindNoteOffsetResult ¶
type FindNoteOffsetResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewFindNoteOffsetResult ¶
func NewFindNoteOffsetResult() *FindNoteOffsetResult
func (*FindNoteOffsetResult) String ¶
func (p *FindNoteOffsetResult) String() string
type FindNotesArgs ¶
type FindNotesArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Filter *NoteFilter `thrift:"filter,2"` Offset int32 `thrift:"offset,3"` MaxNotes int32 `thrift:"maxNotes,4"` }
func NewFindNotesArgs ¶
func NewFindNotesArgs() *FindNotesArgs
func (*FindNotesArgs) String ¶
func (p *FindNotesArgs) String() string
type FindNotesMetadataArgs ¶
type FindNotesMetadataArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Filter *NoteFilter `thrift:"filter,2"` Offset int32 `thrift:"offset,3"` MaxNotes int32 `thrift:"maxNotes,4"` ResultSpec *NotesMetadataResultSpec `thrift:"resultSpec,5"` }
func NewFindNotesMetadataArgs ¶
func NewFindNotesMetadataArgs() *FindNotesMetadataArgs
func (*FindNotesMetadataArgs) String ¶
func (p *FindNotesMetadataArgs) String() string
type FindNotesMetadataResult ¶
type FindNotesMetadataResult struct { Success *NotesMetadataList `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewFindNotesMetadataResult ¶
func NewFindNotesMetadataResult() *FindNotesMetadataResult
func (*FindNotesMetadataResult) String ¶
func (p *FindNotesMetadataResult) String() string
type FindNotesResult ¶
type FindNotesResult struct { Success *NoteList `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewFindNotesResult ¶
func NewFindNotesResult() *FindNotesResult
func (*FindNotesResult) String ¶
func (p *FindNotesResult) String() string
type FindRelatedArgs ¶
type FindRelatedArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Query *RelatedQuery `thrift:"query,2"` ResultSpec *RelatedResultSpec `thrift:"resultSpec,3"` }
func NewFindRelatedArgs ¶
func NewFindRelatedArgs() *FindRelatedArgs
func (*FindRelatedArgs) String ¶
func (p *FindRelatedArgs) String() string
type FindRelatedResult ¶
type FindRelatedResult struct { Success *RelatedResult `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewFindRelatedResult ¶
func NewFindRelatedResult() *FindRelatedResult
func (*FindRelatedResult) String ¶
func (p *FindRelatedResult) String() string
type GetDefaultNotebookArgs ¶
type GetDefaultNotebookArgs struct {
AuthenticationToken string `thrift:"authenticationToken,1"`
}
func NewGetDefaultNotebookArgs ¶
func NewGetDefaultNotebookArgs() *GetDefaultNotebookArgs
func (*GetDefaultNotebookArgs) String ¶
func (p *GetDefaultNotebookArgs) String() string
type GetDefaultNotebookResult ¶
type GetDefaultNotebookResult struct { Success *Types.Notebook `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewGetDefaultNotebookResult ¶
func NewGetDefaultNotebookResult() *GetDefaultNotebookResult
func (*GetDefaultNotebookResult) String ¶
func (p *GetDefaultNotebookResult) String() string
type GetFilteredSyncChunkArgs ¶
type GetFilteredSyncChunkArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` AfterUSN int32 `thrift:"afterUSN,2"` MaxEntries int32 `thrift:"maxEntries,3"` Filter *SyncChunkFilter `thrift:"filter,4"` }
func NewGetFilteredSyncChunkArgs ¶
func NewGetFilteredSyncChunkArgs() *GetFilteredSyncChunkArgs
func (*GetFilteredSyncChunkArgs) String ¶
func (p *GetFilteredSyncChunkArgs) String() string
type GetFilteredSyncChunkResult ¶
type GetFilteredSyncChunkResult struct { Success *SyncChunk `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewGetFilteredSyncChunkResult ¶
func NewGetFilteredSyncChunkResult() *GetFilteredSyncChunkResult
func (*GetFilteredSyncChunkResult) String ¶
func (p *GetFilteredSyncChunkResult) String() string
type GetLinkedNotebookSyncChunkArgs ¶
type GetLinkedNotebookSyncChunkArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` LinkedNotebook *Types.LinkedNotebook `thrift:"linkedNotebook,2"` AfterUSN int32 `thrift:"afterUSN,3"` MaxEntries int32 `thrift:"maxEntries,4"` FullSyncOnly bool `thrift:"fullSyncOnly,5"` }
func NewGetLinkedNotebookSyncChunkArgs ¶
func NewGetLinkedNotebookSyncChunkArgs() *GetLinkedNotebookSyncChunkArgs
func (*GetLinkedNotebookSyncChunkArgs) String ¶
func (p *GetLinkedNotebookSyncChunkArgs) String() string
type GetLinkedNotebookSyncChunkResult ¶
type GetLinkedNotebookSyncChunkResult struct { Success *SyncChunk `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetLinkedNotebookSyncChunkResult ¶
func NewGetLinkedNotebookSyncChunkResult() *GetLinkedNotebookSyncChunkResult
func (*GetLinkedNotebookSyncChunkResult) String ¶
func (p *GetLinkedNotebookSyncChunkResult) String() string
type GetLinkedNotebookSyncStateArgs ¶
type GetLinkedNotebookSyncStateArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` LinkedNotebook *Types.LinkedNotebook `thrift:"linkedNotebook,2"` }
func NewGetLinkedNotebookSyncStateArgs ¶
func NewGetLinkedNotebookSyncStateArgs() *GetLinkedNotebookSyncStateArgs
func (*GetLinkedNotebookSyncStateArgs) String ¶
func (p *GetLinkedNotebookSyncStateArgs) String() string
type GetLinkedNotebookSyncStateResult ¶
type GetLinkedNotebookSyncStateResult struct { Success *SyncState `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetLinkedNotebookSyncStateResult ¶
func NewGetLinkedNotebookSyncStateResult() *GetLinkedNotebookSyncStateResult
func (*GetLinkedNotebookSyncStateResult) String ¶
func (p *GetLinkedNotebookSyncStateResult) String() string
type GetNoteApplicationDataArgs ¶
type GetNoteApplicationDataArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetNoteApplicationDataArgs ¶
func NewGetNoteApplicationDataArgs() *GetNoteApplicationDataArgs
func (*GetNoteApplicationDataArgs) String ¶
func (p *GetNoteApplicationDataArgs) String() string
type GetNoteApplicationDataEntryArgs ¶
type GetNoteApplicationDataEntryArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` Key string `thrift:"key,3"` }
func NewGetNoteApplicationDataEntryArgs ¶
func NewGetNoteApplicationDataEntryArgs() *GetNoteApplicationDataEntryArgs
func (*GetNoteApplicationDataEntryArgs) String ¶
func (p *GetNoteApplicationDataEntryArgs) String() string
type GetNoteApplicationDataEntryResult ¶
type GetNoteApplicationDataEntryResult struct { Success string `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetNoteApplicationDataEntryResult ¶
func NewGetNoteApplicationDataEntryResult() *GetNoteApplicationDataEntryResult
func (*GetNoteApplicationDataEntryResult) String ¶
func (p *GetNoteApplicationDataEntryResult) String() string
type GetNoteApplicationDataResult ¶
type GetNoteApplicationDataResult struct { Success *Types.LazyMap `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetNoteApplicationDataResult ¶
func NewGetNoteApplicationDataResult() *GetNoteApplicationDataResult
func (*GetNoteApplicationDataResult) String ¶
func (p *GetNoteApplicationDataResult) String() string
type GetNoteArgs ¶
type GetNoteArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` WithContent bool `thrift:"withContent,3"` WithResourcesData bool `thrift:"withResourcesData,4"` WithResourcesRecognition bool `thrift:"withResourcesRecognition,5"` WithResourcesAlternateData bool `thrift:"withResourcesAlternateData,6"` }
func NewGetNoteArgs ¶
func NewGetNoteArgs() *GetNoteArgs
func (*GetNoteArgs) String ¶
func (p *GetNoteArgs) String() string
type GetNoteContentArgs ¶
type GetNoteContentArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetNoteContentArgs ¶
func NewGetNoteContentArgs() *GetNoteContentArgs
func (*GetNoteContentArgs) String ¶
func (p *GetNoteContentArgs) String() string
type GetNoteContentResult ¶
type GetNoteContentResult struct { Success string `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetNoteContentResult ¶
func NewGetNoteContentResult() *GetNoteContentResult
func (*GetNoteContentResult) String ¶
func (p *GetNoteContentResult) String() string
type GetNoteResult ¶
type GetNoteResult struct { Success *Types.Note `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetNoteResult ¶
func NewGetNoteResult() *GetNoteResult
func (*GetNoteResult) String ¶
func (p *GetNoteResult) String() string
type GetNoteSearchTextArgs ¶
type GetNoteSearchTextArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` NoteOnly bool `thrift:"noteOnly,3"` TokenizeForIndexing bool `thrift:"tokenizeForIndexing,4"` }
func NewGetNoteSearchTextArgs ¶
func NewGetNoteSearchTextArgs() *GetNoteSearchTextArgs
func (*GetNoteSearchTextArgs) String ¶
func (p *GetNoteSearchTextArgs) String() string
type GetNoteSearchTextResult ¶
type GetNoteSearchTextResult struct { Success string `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetNoteSearchTextResult ¶
func NewGetNoteSearchTextResult() *GetNoteSearchTextResult
func (*GetNoteSearchTextResult) String ¶
func (p *GetNoteSearchTextResult) String() string
type GetNoteTagNamesArgs ¶
type GetNoteTagNamesArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetNoteTagNamesArgs ¶
func NewGetNoteTagNamesArgs() *GetNoteTagNamesArgs
func (*GetNoteTagNamesArgs) String ¶
func (p *GetNoteTagNamesArgs) String() string
type GetNoteTagNamesResult ¶
type GetNoteTagNamesResult struct { Success []string `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetNoteTagNamesResult ¶
func NewGetNoteTagNamesResult() *GetNoteTagNamesResult
func (*GetNoteTagNamesResult) String ¶
func (p *GetNoteTagNamesResult) String() string
type GetNoteVersionArgs ¶
type GetNoteVersionArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` NoteGuid Types.Guid `thrift:"noteGuid,2"` UpdateSequenceNum int32 `thrift:"updateSequenceNum,3"` WithResourcesData bool `thrift:"withResourcesData,4"` WithResourcesRecognition bool `thrift:"withResourcesRecognition,5"` WithResourcesAlternateData bool `thrift:"withResourcesAlternateData,6"` }
func NewGetNoteVersionArgs ¶
func NewGetNoteVersionArgs() *GetNoteVersionArgs
func (*GetNoteVersionArgs) String ¶
func (p *GetNoteVersionArgs) String() string
type GetNoteVersionResult ¶
type GetNoteVersionResult struct { Success *Types.Note `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetNoteVersionResult ¶
func NewGetNoteVersionResult() *GetNoteVersionResult
func (*GetNoteVersionResult) String ¶
func (p *GetNoteVersionResult) String() string
type GetNotebookArgs ¶
type GetNotebookArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetNotebookArgs ¶
func NewGetNotebookArgs() *GetNotebookArgs
func (*GetNotebookArgs) String ¶
func (p *GetNotebookArgs) String() string
type GetNotebookResult ¶
type GetNotebookResult struct { Success *Types.Notebook `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetNotebookResult ¶
func NewGetNotebookResult() *GetNotebookResult
func (*GetNotebookResult) String ¶
func (p *GetNotebookResult) String() string
type GetPublicNotebookArgs ¶
type GetPublicNotebookArgs struct { UserId Types.UserID `thrift:"userId,1"` PublicUri string `thrift:"publicUri,2"` }
func NewGetPublicNotebookArgs ¶
func NewGetPublicNotebookArgs() *GetPublicNotebookArgs
func (*GetPublicNotebookArgs) String ¶
func (p *GetPublicNotebookArgs) String() string
type GetPublicNotebookResult ¶
type GetPublicNotebookResult struct { Success *Types.Notebook `thrift:"success,0"` SystemException *Errors.EDAMSystemException `thrift:"systemException,1"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,2"` }
func NewGetPublicNotebookResult ¶
func NewGetPublicNotebookResult() *GetPublicNotebookResult
func (*GetPublicNotebookResult) String ¶
func (p *GetPublicNotebookResult) String() string
type GetResourceAlternateDataArgs ¶
type GetResourceAlternateDataArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetResourceAlternateDataArgs ¶
func NewGetResourceAlternateDataArgs() *GetResourceAlternateDataArgs
func (*GetResourceAlternateDataArgs) String ¶
func (p *GetResourceAlternateDataArgs) String() string
type GetResourceAlternateDataResult ¶
type GetResourceAlternateDataResult struct { Success []byte `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetResourceAlternateDataResult ¶
func NewGetResourceAlternateDataResult() *GetResourceAlternateDataResult
func (*GetResourceAlternateDataResult) String ¶
func (p *GetResourceAlternateDataResult) String() string
type GetResourceApplicationDataArgs ¶
type GetResourceApplicationDataArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetResourceApplicationDataArgs ¶
func NewGetResourceApplicationDataArgs() *GetResourceApplicationDataArgs
func (*GetResourceApplicationDataArgs) String ¶
func (p *GetResourceApplicationDataArgs) String() string
type GetResourceApplicationDataEntryArgs ¶
type GetResourceApplicationDataEntryArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` Key string `thrift:"key,3"` }
func NewGetResourceApplicationDataEntryArgs ¶
func NewGetResourceApplicationDataEntryArgs() *GetResourceApplicationDataEntryArgs
func (*GetResourceApplicationDataEntryArgs) String ¶
func (p *GetResourceApplicationDataEntryArgs) String() string
type GetResourceApplicationDataEntryResult ¶
type GetResourceApplicationDataEntryResult struct { Success string `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetResourceApplicationDataEntryResult ¶
func NewGetResourceApplicationDataEntryResult() *GetResourceApplicationDataEntryResult
func (*GetResourceApplicationDataEntryResult) String ¶
func (p *GetResourceApplicationDataEntryResult) String() string
type GetResourceApplicationDataResult ¶
type GetResourceApplicationDataResult struct { Success *Types.LazyMap `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetResourceApplicationDataResult ¶
func NewGetResourceApplicationDataResult() *GetResourceApplicationDataResult
func (*GetResourceApplicationDataResult) String ¶
func (p *GetResourceApplicationDataResult) String() string
type GetResourceArgs ¶
type GetResourceArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` WithData bool `thrift:"withData,3"` WithRecognition bool `thrift:"withRecognition,4"` WithAttributes bool `thrift:"withAttributes,5"` WithAlternateData bool `thrift:"withAlternateData,6"` }
func NewGetResourceArgs ¶
func NewGetResourceArgs() *GetResourceArgs
func (*GetResourceArgs) String ¶
func (p *GetResourceArgs) String() string
type GetResourceAttributesArgs ¶
type GetResourceAttributesArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetResourceAttributesArgs ¶
func NewGetResourceAttributesArgs() *GetResourceAttributesArgs
func (*GetResourceAttributesArgs) String ¶
func (p *GetResourceAttributesArgs) String() string
type GetResourceAttributesResult ¶
type GetResourceAttributesResult struct { Success *Types.ResourceAttributes `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetResourceAttributesResult ¶
func NewGetResourceAttributesResult() *GetResourceAttributesResult
func (*GetResourceAttributesResult) String ¶
func (p *GetResourceAttributesResult) String() string
type GetResourceByHashArgs ¶
type GetResourceByHashArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` NoteGuid Types.Guid `thrift:"noteGuid,2"` ContentHash []byte `thrift:"contentHash,3"` WithData bool `thrift:"withData,4"` WithRecognition bool `thrift:"withRecognition,5"` WithAlternateData bool `thrift:"withAlternateData,6"` }
func NewGetResourceByHashArgs ¶
func NewGetResourceByHashArgs() *GetResourceByHashArgs
func (*GetResourceByHashArgs) String ¶
func (p *GetResourceByHashArgs) String() string
type GetResourceByHashResult ¶
type GetResourceByHashResult struct { Success *Types.Resource `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetResourceByHashResult ¶
func NewGetResourceByHashResult() *GetResourceByHashResult
func (*GetResourceByHashResult) String ¶
func (p *GetResourceByHashResult) String() string
type GetResourceDataArgs ¶
type GetResourceDataArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetResourceDataArgs ¶
func NewGetResourceDataArgs() *GetResourceDataArgs
func (*GetResourceDataArgs) String ¶
func (p *GetResourceDataArgs) String() string
type GetResourceDataResult ¶
type GetResourceDataResult struct { Success []byte `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetResourceDataResult ¶
func NewGetResourceDataResult() *GetResourceDataResult
func (*GetResourceDataResult) String ¶
func (p *GetResourceDataResult) String() string
type GetResourceRecognitionArgs ¶
type GetResourceRecognitionArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetResourceRecognitionArgs ¶
func NewGetResourceRecognitionArgs() *GetResourceRecognitionArgs
func (*GetResourceRecognitionArgs) String ¶
func (p *GetResourceRecognitionArgs) String() string
type GetResourceRecognitionResult ¶
type GetResourceRecognitionResult struct { Success []byte `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetResourceRecognitionResult ¶
func NewGetResourceRecognitionResult() *GetResourceRecognitionResult
func (*GetResourceRecognitionResult) String ¶
func (p *GetResourceRecognitionResult) String() string
type GetResourceResult ¶
type GetResourceResult struct { Success *Types.Resource `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetResourceResult ¶
func NewGetResourceResult() *GetResourceResult
func (*GetResourceResult) String ¶
func (p *GetResourceResult) String() string
type GetResourceSearchTextArgs ¶
type GetResourceSearchTextArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetResourceSearchTextArgs ¶
func NewGetResourceSearchTextArgs() *GetResourceSearchTextArgs
func (*GetResourceSearchTextArgs) String ¶
func (p *GetResourceSearchTextArgs) String() string
type GetResourceSearchTextResult ¶
type GetResourceSearchTextResult struct { Success string `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetResourceSearchTextResult ¶
func NewGetResourceSearchTextResult() *GetResourceSearchTextResult
func (*GetResourceSearchTextResult) String ¶
func (p *GetResourceSearchTextResult) String() string
type GetSearchArgs ¶
type GetSearchArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetSearchArgs ¶
func NewGetSearchArgs() *GetSearchArgs
func (*GetSearchArgs) String ¶
func (p *GetSearchArgs) String() string
type GetSearchResult ¶
type GetSearchResult struct { Success *Types.SavedSearch `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetSearchResult ¶
func NewGetSearchResult() *GetSearchResult
func (*GetSearchResult) String ¶
func (p *GetSearchResult) String() string
type GetSharedNotebookByAuthArgs ¶
type GetSharedNotebookByAuthArgs struct {
}func NewGetSharedNotebookByAuthArgs ¶
func NewGetSharedNotebookByAuthArgs() *GetSharedNotebookByAuthArgs
func (*GetSharedNotebookByAuthArgs) String ¶
func (p *GetSharedNotebookByAuthArgs) String() string
type GetSharedNotebookByAuthResult ¶
type GetSharedNotebookByAuthResult struct {}
func NewGetSharedNotebookByAuthResult ¶
func NewGetSharedNotebookByAuthResult() *GetSharedNotebookByAuthResult
func (*GetSharedNotebookByAuthResult) String ¶
func (p *GetSharedNotebookByAuthResult) String() string
type GetSyncChunkArgs ¶
type GetSyncChunkArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` AfterUSN int32 `thrift:"afterUSN,2"` MaxEntries int32 `thrift:"maxEntries,3"` FullSyncOnly bool `thrift:"fullSyncOnly,4"` }
func NewGetSyncChunkArgs ¶
func NewGetSyncChunkArgs() *GetSyncChunkArgs
func (*GetSyncChunkArgs) String ¶
func (p *GetSyncChunkArgs) String() string
type GetSyncChunkResult ¶
type GetSyncChunkResult struct { Success *SyncChunk `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewGetSyncChunkResult ¶
func NewGetSyncChunkResult() *GetSyncChunkResult
func (*GetSyncChunkResult) String ¶
func (p *GetSyncChunkResult) String() string
type GetSyncStateArgs ¶
type GetSyncStateArgs struct {
AuthenticationToken string `thrift:"authenticationToken,1"`
}
func NewGetSyncStateArgs ¶
func NewGetSyncStateArgs() *GetSyncStateArgs
func (*GetSyncStateArgs) String ¶
func (p *GetSyncStateArgs) String() string
type GetSyncStateResult ¶
type GetSyncStateResult struct { Success *SyncState `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewGetSyncStateResult ¶
func NewGetSyncStateResult() *GetSyncStateResult
func (*GetSyncStateResult) String ¶
func (p *GetSyncStateResult) String() string
type GetSyncStateWithMetricsArgs ¶
type GetSyncStateWithMetricsArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` ClientMetrics *ClientUsageMetrics `thrift:"clientMetrics,2"` }
func NewGetSyncStateWithMetricsArgs ¶
func NewGetSyncStateWithMetricsArgs() *GetSyncStateWithMetricsArgs
func (*GetSyncStateWithMetricsArgs) String ¶
func (p *GetSyncStateWithMetricsArgs) String() string
type GetSyncStateWithMetricsResult ¶
type GetSyncStateWithMetricsResult struct { Success *SyncState `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewGetSyncStateWithMetricsResult ¶
func NewGetSyncStateWithMetricsResult() *GetSyncStateWithMetricsResult
func (*GetSyncStateWithMetricsResult) String ¶
func (p *GetSyncStateWithMetricsResult) String() string
type GetTagArgs ¶
type GetTagArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewGetTagArgs ¶
func NewGetTagArgs() *GetTagArgs
func (*GetTagArgs) String ¶
func (p *GetTagArgs) String() string
type GetTagResult ¶
type GetTagResult struct { Success *Types.Tag `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewGetTagResult ¶
func NewGetTagResult() *GetTagResult
func (*GetTagResult) String ¶
func (p *GetTagResult) String() string
type ListLinkedNotebooksArgs ¶
type ListLinkedNotebooksArgs struct {
AuthenticationToken string `thrift:"authenticationToken,1"`
}
func NewListLinkedNotebooksArgs ¶
func NewListLinkedNotebooksArgs() *ListLinkedNotebooksArgs
func (*ListLinkedNotebooksArgs) String ¶
func (p *ListLinkedNotebooksArgs) String() string
type ListLinkedNotebooksResult ¶
type ListLinkedNotebooksResult struct { Success []*Types.LinkedNotebook `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,2"` SystemException *Errors.EDAMSystemException `thrift:"systemException,3"` }
func NewListLinkedNotebooksResult ¶
func NewListLinkedNotebooksResult() *ListLinkedNotebooksResult
func (*ListLinkedNotebooksResult) String ¶
func (p *ListLinkedNotebooksResult) String() string
type ListNoteVersionsArgs ¶
type ListNoteVersionsArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` NoteGuid Types.Guid `thrift:"noteGuid,2"` }
func NewListNoteVersionsArgs ¶
func NewListNoteVersionsArgs() *ListNoteVersionsArgs
func (*ListNoteVersionsArgs) String ¶
func (p *ListNoteVersionsArgs) String() string
type ListNoteVersionsResult ¶
type ListNoteVersionsResult struct { Success []*NoteVersionId `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewListNoteVersionsResult ¶
func NewListNoteVersionsResult() *ListNoteVersionsResult
func (*ListNoteVersionsResult) String ¶
func (p *ListNoteVersionsResult) String() string
type ListNotebooksArgs ¶
type ListNotebooksArgs struct {
AuthenticationToken string `thrift:"authenticationToken,1"`
}
func NewListNotebooksArgs ¶
func NewListNotebooksArgs() *ListNotebooksArgs
func (*ListNotebooksArgs) String ¶
func (p *ListNotebooksArgs) String() string
type ListNotebooksResult ¶
type ListNotebooksResult struct { Success []*Types.Notebook `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewListNotebooksResult ¶
func NewListNotebooksResult() *ListNotebooksResult
func (*ListNotebooksResult) String ¶
func (p *ListNotebooksResult) String() string
type ListSearchesArgs ¶
type ListSearchesArgs struct {
AuthenticationToken string `thrift:"authenticationToken,1"`
}
func NewListSearchesArgs ¶
func NewListSearchesArgs() *ListSearchesArgs
func (*ListSearchesArgs) String ¶
func (p *ListSearchesArgs) String() string
type ListSearchesResult ¶
type ListSearchesResult struct { Success []*Types.SavedSearch `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewListSearchesResult ¶
func NewListSearchesResult() *ListSearchesResult
func (*ListSearchesResult) String ¶
func (p *ListSearchesResult) String() string
type ListSharedNotebooksArgs ¶
type ListSharedNotebooksArgs struct {
}func NewListSharedNotebooksArgs ¶
func NewListSharedNotebooksArgs() *ListSharedNotebooksArgs
func (*ListSharedNotebooksArgs) String ¶
func (p *ListSharedNotebooksArgs) String() string
type ListSharedNotebooksResult ¶
type ListSharedNotebooksResult struct {}
func NewListSharedNotebooksResult ¶
func NewListSharedNotebooksResult() *ListSharedNotebooksResult
func (*ListSharedNotebooksResult) String ¶
func (p *ListSharedNotebooksResult) String() string
type ListTagsArgs ¶
type ListTagsArgs struct {
AuthenticationToken string `thrift:"authenticationToken,1"`
}
func NewListTagsArgs ¶
func NewListTagsArgs() *ListTagsArgs
func (*ListTagsArgs) String ¶
func (p *ListTagsArgs) String() string
type ListTagsByNotebookArgs ¶
type ListTagsByNotebookArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` NotebookGuid Types.Guid `thrift:"notebookGuid,2"` }
func NewListTagsByNotebookArgs ¶
func NewListTagsByNotebookArgs() *ListTagsByNotebookArgs
func (*ListTagsByNotebookArgs) String ¶
func (p *ListTagsByNotebookArgs) String() string
type ListTagsByNotebookResult ¶
type ListTagsByNotebookResult struct { Success []*Types.Tag `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewListTagsByNotebookResult ¶
func NewListTagsByNotebookResult() *ListTagsByNotebookResult
func (*ListTagsByNotebookResult) String ¶
func (p *ListTagsByNotebookResult) String() string
type ListTagsResult ¶
type ListTagsResult struct { Success []*Types.Tag `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` }
func NewListTagsResult ¶
func NewListTagsResult() *ListTagsResult
func (*ListTagsResult) String ¶
func (p *ListTagsResult) String() string
type NoteCollectionCounts ¶
type NoteCollectionCounts struct { NotebookCounts map[Types.Guid]int32 `thrift:"notebookCounts,1"` TagCounts map[Types.Guid]int32 `thrift:"tagCounts,2"` TrashCount int32 `thrift:"trashCount,3"` }
func NewNoteCollectionCounts ¶
func NewNoteCollectionCounts() *NoteCollectionCounts
func (*NoteCollectionCounts) IsSetNotebookCounts ¶
func (p *NoteCollectionCounts) IsSetNotebookCounts() bool
func (*NoteCollectionCounts) IsSetTagCounts ¶
func (p *NoteCollectionCounts) IsSetTagCounts() bool
func (*NoteCollectionCounts) IsSetTrashCount ¶
func (p *NoteCollectionCounts) IsSetTrashCount() bool
func (*NoteCollectionCounts) String ¶
func (p *NoteCollectionCounts) String() string
type NoteEmailParameters ¶
type NoteEmailParameters struct { Guid string `thrift:"guid,1"` Note *Types.Note `thrift:"note,2"` ToAddresses []string `thrift:"toAddresses,3"` CcAddresses []string `thrift:"ccAddresses,4"` Subject string `thrift:"subject,5"` Message string `thrift:"message,6"` }
func NewNoteEmailParameters ¶
func NewNoteEmailParameters() *NoteEmailParameters
func (*NoteEmailParameters) IsSetCcAddresses ¶
func (p *NoteEmailParameters) IsSetCcAddresses() bool
func (*NoteEmailParameters) IsSetGuid ¶
func (p *NoteEmailParameters) IsSetGuid() bool
func (*NoteEmailParameters) IsSetMessage ¶
func (p *NoteEmailParameters) IsSetMessage() bool
func (*NoteEmailParameters) IsSetNote ¶
func (p *NoteEmailParameters) IsSetNote() bool
func (*NoteEmailParameters) IsSetSubject ¶
func (p *NoteEmailParameters) IsSetSubject() bool
func (*NoteEmailParameters) IsSetToAddresses ¶
func (p *NoteEmailParameters) IsSetToAddresses() bool
func (*NoteEmailParameters) String ¶
func (p *NoteEmailParameters) String() string
type NoteFilter ¶
type NoteFilter struct { Order int32 `thrift:"order,1"` Ascending bool `thrift:"ascending,2"` Words string `thrift:"words,3"` NotebookGuid Types.Guid `thrift:"notebookGuid,4"` TagGuids []Types.Guid `thrift:"tagGuids,5"` TimeZone string `thrift:"timeZone,6"` Inactive bool `thrift:"inactive,7"` Emphasized string `thrift:"emphasized,8"` }
func NewNoteFilter ¶
func NewNoteFilter() *NoteFilter
func (*NoteFilter) IsSetAscending ¶
func (p *NoteFilter) IsSetAscending() bool
func (*NoteFilter) IsSetEmphasized ¶
func (p *NoteFilter) IsSetEmphasized() bool
func (*NoteFilter) IsSetInactive ¶
func (p *NoteFilter) IsSetInactive() bool
func (*NoteFilter) IsSetNotebookGuid ¶
func (p *NoteFilter) IsSetNotebookGuid() bool
func (*NoteFilter) IsSetOrder ¶
func (p *NoteFilter) IsSetOrder() bool
func (*NoteFilter) IsSetTagGuids ¶
func (p *NoteFilter) IsSetTagGuids() bool
func (*NoteFilter) IsSetTimeZone ¶
func (p *NoteFilter) IsSetTimeZone() bool
func (*NoteFilter) IsSetWords ¶
func (p *NoteFilter) IsSetWords() bool
func (*NoteFilter) String ¶
func (p *NoteFilter) String() string
type NoteList ¶
type NoteList struct { StartIndex int32 `thrift:"startIndex,1,required"` TotalNotes int32 `thrift:"totalNotes,2,required"` Notes []*Types.Note `thrift:"notes,3,required"` StoppedWords []string `thrift:"stoppedWords,4"` SearchedWords []string `thrift:"searchedWords,5"` UpdateCount int32 `thrift:"updateCount,6"` }
func NewNoteList ¶
func NewNoteList() *NoteList
func (*NoteList) IsSetSearchedWords ¶
func (*NoteList) IsSetStoppedWords ¶
func (*NoteList) IsSetUpdateCount ¶
type NoteMetadata ¶
type NoteMetadata struct { Guid Types.Guid `thrift:"guid,1,required"` Title string `thrift:"title,2"` // unused field # 3 // unused field # 4 ContentLength int32 `thrift:"contentLength,5"` Created Types.Timestamp `thrift:"created,6"` Updated Types.Timestamp `thrift:"updated,7"` Deleted Types.Timestamp `thrift:"deleted,8"` // unused field # 9 UpdateSequenceNum int32 `thrift:"updateSequenceNum,10"` NotebookGuid string `thrift:"notebookGuid,11"` TagGuids []Types.Guid `thrift:"tagGuids,12"` // unused field # 13 Attributes *Types.NoteAttributes `thrift:"attributes,14"` // unused field # 15 // unused field # 16 // unused field # 17 // unused field # 18 // unused field # 19 LargestResourceMime string `thrift:"largestResourceMime,20"` LargestResourceSize int32 `thrift:"largestResourceSize,21"` }
func NewNoteMetadata ¶
func NewNoteMetadata() *NoteMetadata
func (*NoteMetadata) IsSetAttributes ¶
func (p *NoteMetadata) IsSetAttributes() bool
func (*NoteMetadata) IsSetContentLength ¶
func (p *NoteMetadata) IsSetContentLength() bool
func (*NoteMetadata) IsSetCreated ¶
func (p *NoteMetadata) IsSetCreated() bool
func (*NoteMetadata) IsSetDeleted ¶
func (p *NoteMetadata) IsSetDeleted() bool
func (*NoteMetadata) IsSetLargestResourceMime ¶
func (p *NoteMetadata) IsSetLargestResourceMime() bool
func (*NoteMetadata) IsSetLargestResourceSize ¶
func (p *NoteMetadata) IsSetLargestResourceSize() bool
func (*NoteMetadata) IsSetNotebookGuid ¶
func (p *NoteMetadata) IsSetNotebookGuid() bool
func (*NoteMetadata) IsSetTagGuids ¶
func (p *NoteMetadata) IsSetTagGuids() bool
func (*NoteMetadata) IsSetTitle ¶
func (p *NoteMetadata) IsSetTitle() bool
func (*NoteMetadata) IsSetUpdateSequenceNum ¶
func (p *NoteMetadata) IsSetUpdateSequenceNum() bool
func (*NoteMetadata) IsSetUpdated ¶
func (p *NoteMetadata) IsSetUpdated() bool
func (*NoteMetadata) String ¶
func (p *NoteMetadata) String() string
type NoteStore ¶
type NoteStore interface { // Asks the NoteStore to provide information about the status of the user // account corresponding to the provided authentication token. // // Parameters: // - AuthenticationToken GetSyncState(ctx context.Context, authenticationToken string) (r *SyncState, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Asks the NoteStore to provide information about the status of the user // account corresponding to the provided authentication token. // This version of 'getSyncState' allows the client to upload coarse- // grained usage metrics to the service. // // @param clientMetrics see the documentation of the ClientUsageMetrics // structure for an explanation of the fields that clients can pass to // the service. // // Parameters: // - AuthenticationToken // - ClientMetrics GetSyncStateWithMetrics(ctx context.Context, authenticationToken string, clientMetrics *ClientUsageMetrics) (r *SyncState, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // DEPRECATED - use getFilteredSyncChunk. // // Parameters: // - AuthenticationToken // - AfterUSN // - MaxEntries // - FullSyncOnly GetSyncChunk(ctx context.Context, authenticationToken string, afterUSN int32, maxEntries int32, fullSyncOnly bool) (r *SyncChunk, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Asks the NoteStore to provide the state of the account in order of // last modification. This request retrieves one block of the server's // state so that a client can make several small requests against a large // account rather than getting the entire state in one big message. // This call gives fine-grained control of the data that will // be received by a client by omitting data elements that a client doesn't // need. This may reduce network traffic and sync times. // // @param afterUSN // The client can pass this value to ask only for objects that // have been updated after a certain point. This allows the client to // receive updates after its last checkpoint rather than doing a full // synchronization on every pass. The default value of "0" indicates // that the client wants to get objects from the start of the account. // // @param maxEntries // The maximum number of modified objects that should be // returned in the result SyncChunk. This can be used to limit the size // of each individual message to be friendly for network transfer. // // @param filter // The caller must set some of the flags in this structure to specify which // data types should be returned during the synchronization. See // the SyncChunkFilter structure for information on each flag. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "afterUSN" - if negative // </li> // <li> BAD_DATA_FORMAT "maxEntries" - if less than 1 // </li> // </ul> // // Parameters: // - AuthenticationToken // - AfterUSN // - MaxEntries // - Filter GetFilteredSyncChunk(ctx context.Context, authenticationToken string, afterUSN int32, maxEntries int32, filter *SyncChunkFilter) (r *SyncChunk, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Asks the NoteStore to provide information about the status of a linked // notebook that has been shared with the caller, or that is public to the // world. // This will return a result that is similar to getSyncState, but may omit // SyncState.uploaded if the caller doesn't have permission to write to // the linked notebook. // // This function must be called on the shard that owns the referenced // notebook. (I.e. the shardId in /shard/shardId/edam/note must be the // same as LinkedNotebook.shardId.) // // @param authenticationToken // This should be an authenticationToken for the guest who has received // the invitation to the share. (I.e. this should not be the result of // NoteStore.authenticateToSharedNotebook) // // @param linkedNotebook // This structure should contain identifying information and permissions // to access the notebook in question. // // Parameters: // - AuthenticationToken // - LinkedNotebook GetLinkedNotebookSyncState(ctx context.Context, authenticationToken string, linkedNotebook *Types.LinkedNotebook) (r *SyncState, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Asks the NoteStore to provide information about the contents of a linked // notebook that has been shared with the caller, or that is public to the // world. // This will return a result that is similar to getSyncChunk, but will only // contain entries that are visible to the caller. I.e. only that particular // Notebook will be visible, along with its Notes, and Tags on those Notes. // // This function must be called on the shard that owns the referenced // notebook. (I.e. the shardId in /shard/shardId/edam/note must be the // same as LinkedNotebook.shardId.) // // @param authenticationToken // This should be an authenticationToken for the guest who has received // the invitation to the share. (I.e. this should not be the result of // NoteStore.authenticateToSharedNotebook) // // @param linkedNotebook // This structure should contain identifying information and permissions // to access the notebook in question. This must contain the valid fields // for either a shared notebook (e.g. shareKey) // or a public notebook (e.g. username, uri) // // @param afterUSN // The client can pass this value to ask only for objects that // have been updated after a certain point. This allows the client to // receive updates after its last checkpoint rather than doing a full // synchronization on every pass. The default value of "0" indicates // that the client wants to get objects from the start of the account. // // @param maxEntries // The maximum number of modified objects that should be // returned in the result SyncChunk. This can be used to limit the size // of each individual message to be friendly for network transfer. // Applications should not request more than 256 objects at a time, // and must handle the case where the service returns less than the // requested number of objects in a given request even though more // objects are available on the service. // // @param fullSyncOnly // If true, then the client only wants initial data for a full sync. // In this case, the service will not return any expunged objects, // and will not return any Resources, since these are also provided // in their corresponding Notes. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "afterUSN" - if negative // </li> // <li> BAD_DATA_FORMAT "maxEntries" - if less than 1 // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "LinkedNotebook" - if the provided information doesn't match any // valid notebook // </li> // <li> "LinkedNotebook.uri" - if the provided public URI doesn't match any // valid notebook // </li> // <li> "SharedNotebook.id" - if the provided information indicates a // shared notebook that no longer exists // </li> // </ul> // // Parameters: // - AuthenticationToken // - LinkedNotebook // - AfterUSN // - MaxEntries // - FullSyncOnly GetLinkedNotebookSyncChunk(ctx context.Context, authenticationToken string, linkedNotebook *Types.LinkedNotebook, afterUSN int32, maxEntries int32, fullSyncOnly bool) (r *SyncChunk, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns a list of all of the notebooks in the account. // // Parameters: // - AuthenticationToken ListNotebooks(ctx context.Context, authenticationToken string) (r []*Types.Notebook, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Returns the current state of the notebook with the provided GUID. // The notebook may be active or deleted (but not expunged). // // @param guid // The GUID of the notebook to be retrieved. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Notebook.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Notebook" - private notebook, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Notebook.guid" - tag not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetNotebook(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.Notebook, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns the notebook that should be used to store new notes in the // user's account when no other notebooks are specified. // // Parameters: // - AuthenticationToken GetDefaultNotebook(ctx context.Context, authenticationToken string) (r *Types.Notebook, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Asks the service to make a notebook with the provided name. // // @param notebook // The desired fields for the notebook must be provided on this // object. The name of the notebook must be set, and either the 'active' // or 'defaultNotebook' fields may be set by the client at creation. // If a notebook exists in the account with the same name (via // case-insensitive compare), this will throw an EDAMUserException. // // @return // The newly created Notebook. The server-side GUID will be // saved in this object's 'guid' field. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Notebook.name" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "Notebook.stack" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "Publishing.uri" - if publishing set but bad uri // </li> // <li> BAD_DATA_FORMAT "Publishing.publicDescription" - if too long // </li> // <li> DATA_CONFLICT "Notebook.name" - name already in use // </li> // <li> DATA_CONFLICT "Publishing.uri" - if URI already in use // </li> // <li> DATA_REQUIRED "Publishing.uri" - if publishing set but uri missing // </li> // <li> LIMIT_REACHED "Notebook" - at max number of notebooks // </li> // </ul> // // Parameters: // - AuthenticationToken // - Notebook CreateNotebook(ctx context.Context, authenticationToken string, notebook *Types.Notebook) (r *Types.Notebook, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Submits notebook changes to the service. The provided data must include // the notebook's guid field for identification. // // @param notebook // The notebook object containing the requested changes. // // @return // The Update Sequence Number for this change within the account. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Notebook.name" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "Notebook.stack" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "Publishing.uri" - if publishing set but bad uri // </li> // <li> BAD_DATA_FORMAT "Publishing.publicDescription" - if too long // </li> // <li> DATA_CONFLICT "Notebook.name" - name already in use // </li> // <li> DATA_CONFLICT "Publishing.uri" - if URI already in use // </li> // <li> DATA_REQUIRED "Publishing.uri" - if publishing set but uri missing // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Notebook.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Notebook UpdateNotebook(ctx context.Context, authenticationToken string, notebook *Types.Notebook) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Permanently removes the notebook from the user's account. // After this action, the notebook is no longer available for undeletion, etc. // If the notebook contains any Notes, they will be moved to the current // default notebook and moved into the trash (i.e. Note.active=false). // <p/> // NOTE: This function is generally not available to third party applications. // Calls will result in an EDAMUserException with the error code // PERMISSION_DENIED. // // @param guid // The GUID of the notebook to delete. // // @return // The Update Sequence Number for this change within the account. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Notebook.guid" - if the parameter is missing // </li> // <li> LIMIT_REACHED "Notebook" - trying to expunge the last Notebook // </li> // <li> PERMISSION_DENIED "Notebook" - private notebook, user doesn't own // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid ExpungeNotebook(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns a list of the tags in the account. Evernote does not support // the undeletion of tags, so this will only include active tags. // // Parameters: // - AuthenticationToken ListTags(ctx context.Context, authenticationToken string) (r []*Types.Tag, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Returns a list of the tags that are applied to at least one note within // the provided notebook. If the notebook is public, the authenticationToken // may be ignored. // // @param notebookGuid // the GUID of the notebook to use to find tags // // @throws EDAMNotFoundException <ul> // <li> "Notebook.guid" - notebook not found by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - NotebookGuid ListTagsByNotebook(ctx context.Context, authenticationToken string, notebookGuid Types.Guid) (r []*Types.Tag, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns the current state of the Tag with the provided GUID. // // @param guid // The GUID of the tag to be retrieved. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Tag.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Tag" - private Tag, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Tag.guid" - tag not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetTag(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.Tag, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Asks the service to make a tag with a set of information. // // @param tag // The desired list of fields for the tag are specified in this // object. The caller must specify the tag name, and may provide // the parentGUID. // // @return // The newly created Tag. The server-side GUID will be // saved in this object. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Tag.name" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "Tag.parentGuid" - malformed GUID // </li> // <li> DATA_CONFLICT "Tag.name" - name already in use // </li> // <li> LIMIT_REACHED "Tag" - at max number of tags // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Tag.parentGuid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Tag CreateTag(ctx context.Context, authenticationToken string, tag *Types.Tag) (r *Types.Tag, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Submits tag changes to the service. The provided data must include // the tag's guid field for identification. The service will apply // updates to the following tag fields: name, parentGuid // // @param tag // The tag object containing the requested changes. // // @return // The Update Sequence Number for this change within the account. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Tag.name" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "Tag.parentGuid" - malformed GUID // </li> // <li> DATA_CONFLICT "Tag.name" - name already in use // </li> // <li> DATA_CONFLICT "Tag.parentGuid" - can't set parent: circular // </li> // <li> PERMISSION_DENIED "Tag" - user doesn't own tag // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Tag.guid" - tag not found, by GUID // </li> // <li> "Tag.parentGuid" - parent not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Tag UpdateTag(ctx context.Context, authenticationToken string, tag *Types.Tag) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Removes the provided tag from every note that is currently tagged with // this tag. If this operation is successful, the tag will still be in // the account, but it will not be tagged on any notes. // // This function is not indended for use by full synchronizing clients, since // it does not provide enough result information to the client to reconcile // the local state without performing a follow-up sync from the service. This // is intended for "thin clients" that need to efficiently support this as // a UI operation. // // @param guid // The GUID of the tag to remove from all notes. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Tag.guid" - if the guid parameter is missing // </li> // <li> PERMISSION_DENIED "Tag" - user doesn't own tag // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Tag.guid" - tag not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid UntagAll(ctx context.Context, authenticationToken string, guid Types.Guid) (userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Permanently deletes the tag with the provided GUID, if present. // <p/> // NOTE: This function is generally not available to third party applications. // Calls will result in an EDAMUserException with the error code // PERMISSION_DENIED. // // @param guid // The GUID of the tag to delete. // // @return // The Update Sequence Number for this change within the account. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Tag.guid" - if the guid parameter is missing // </li> // <li> PERMISSION_DENIED "Tag" - user doesn't own tag // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Tag.guid" - tag not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid ExpungeTag(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns a list of the searches in the account. Evernote does not support // the undeletion of searches, so this will only include active searches. // // Parameters: // - AuthenticationToken ListSearches(ctx context.Context, authenticationToken string) (r []*Types.SavedSearch, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Returns the current state of the search with the provided GUID. // // @param guid // The GUID of the search to be retrieved. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "SavedSearch.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "SavedSearch" - private Tag, user doesn't own // </li> // // @throws EDAMNotFoundException <ul> // <li> "SavedSearch.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetSearch(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.SavedSearch, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Asks the service to make a saved search with a set of information. // // @param search // The desired list of fields for the search are specified in this // object. The caller must specify the name and query for the // search, and may optionally specify a search scope. // The SavedSearch.format field is ignored by the service. // // @return // The newly created SavedSearch. The server-side GUID will be // saved in this object. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "SavedSearch.name" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "SavedSearch.query" - invalid length // </li> // <li> DATA_CONFLICT "SavedSearch.name" - name already in use // </li> // <li> LIMIT_REACHED "SavedSearch" - at max number of searches // </li> // </ul> // // Parameters: // - AuthenticationToken // - Search CreateSearch(ctx context.Context, authenticationToken string, search *Types.SavedSearch) (r *Types.SavedSearch, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Submits search changes to the service. The provided data must include // the search's guid field for identification. The service will apply // updates to the following search fields: name, query, and scope. // // @param search // The search object containing the requested changes. // // @return // The Update Sequence Number for this change within the account. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "SavedSearch.name" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "SavedSearch.query" - invalid length // </li> // <li> DATA_CONFLICT "SavedSearch.name" - name already in use // </li> // <li> PERMISSION_DENIED "SavedSearch" - user doesn't own tag // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "SavedSearch.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Search UpdateSearch(ctx context.Context, authenticationToken string, search *Types.SavedSearch) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Permanently deletes the saved search with the provided GUID, if present. // <p/> // NOTE: This function is generally not available to third party applications. // Calls will result in an EDAMUserException with the error code // PERMISSION_DENIED. // // @param guid // The GUID of the search to delete. // // @return // The Update Sequence Number for this change within the account. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "SavedSearch.guid" - if the guid parameter is empty // </li> // <li> PERMISSION_DENIED "SavedSearch" - user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "SavedSearch.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid ExpungeSearch(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // DEPRECATED. Use findNotesMetadata. // // Parameters: // - AuthenticationToken // - Filter // - Offset // - MaxNotes FindNotes(ctx context.Context, authenticationToken string, filter *NoteFilter, offset int32, maxNotes int32) (r *NoteList, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Finds the position of a note within a sorted subset of all of the user's // notes. This may be useful for thin clients that are displaying a paginated // listing of a large account, which need to know where a particular note // sits in the list without retrieving all notes first. // // @param authenticationToken // Must be a valid token for the user's account unless the NoteFilter // 'notebookGuid' is the GUID of a public notebook. // // @param filter // The list of criteria that will constrain the notes to be returned. // // @param guid // The GUID of the note to be retrieved. // // @return // If the note with the provided GUID is found within the matching note // list, this will return the offset of that note within that list (where // the first offset is 0). If the note is not found within the set of // notes, this will return -1. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "offset" - not between 0 and EDAM_USER_NOTES_MAX // </li> // <li> BAD_DATA_FORMAT "maxNotes" - not between 0 and EDAM_USER_NOTES_MAX // </li> // <li> BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed // </li> // <li> BAD_DATA_FORMAT "NoteFilter.tagGuids" - if any are malformed // </li> // <li> BAD_DATA_FORMAT "NoteFilter.words" - if search string too long // </li> // // @throws EDAMNotFoundException <ul> // <li> "Notebook.guid" - not found, by GUID // </li> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Filter // - Guid FindNoteOffset(ctx context.Context, authenticationToken string, filter *NoteFilter, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Used to find the high-level information about a set of the notes from a // user's account based on various criteria specified via a NoteFilter object. // <p/> // Web applications that wish to periodically check for new content in a user's // Evernote account should consider using webhooks instead of polling this API. // See http://dev.evernote.com/documentation/cloud/chapters/polling_notification.php // for more information. // // @param authenticationToken // Must be a valid token for the user's account unless the NoteFilter // 'notebookGuid' is the GUID of a public notebook. // // @param filter // The list of criteria that will constrain the notes to be returned. // // @param offset // The numeric index of the first note to show within the sorted // results. The numbering scheme starts with "0". This can be used for // pagination. // // @param maxNotes // The mximum notes to return in this query. The service will return a set // of notes that is no larger than this number, but may return fewer notes // if needed. The NoteList.totalNotes field in the return value will // indicate whether there are more values available after the returned set. // // @param resultSpec // This specifies which information should be returned for each matching // Note. The fields on this structure can be used to eliminate data that // the client doesn't need, which will reduce the time and bandwidth // to receive and process the reply. // // @return // The list of notes that match the criteria. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "offset" - not between 0 and EDAM_USER_NOTES_MAX // </li> // <li> BAD_DATA_FORMAT "maxNotes" - not between 0 and EDAM_USER_NOTES_MAX // </li> // <li> BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed // </li> // <li> BAD_DATA_FORMAT "NoteFilter.tagGuids" - if any are malformed // </li> // <li> BAD_DATA_FORMAT "NoteFilter.words" - if search string too long // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Notebook.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Filter // - Offset // - MaxNotes // - ResultSpec FindNotesMetadata(ctx context.Context, authenticationToken string, filter *NoteFilter, offset int32, maxNotes int32, resultSpec *NotesMetadataResultSpec) (r *NotesMetadataList, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // This function is used to determine how many notes are found for each // notebook and tag in the user's account, given a current set of filter // parameters that determine the current selection. This function will // return a structure that gives the note count for each notebook and tag // that has at least one note under the requested filter. Any notebook or // tag that has zero notes in the filtered set will not be listed in the // reply to this function (so they can be assumed to be 0). // // @param authenticationToken // Must be a valid token for the user's account unless the NoteFilter // 'notebookGuid' is the GUID of a public notebook. // // @param filter // The note selection filter that is currently being applied. The note // counts are to be calculated with this filter applied to the total set // of notes in the user's account. // // @param withTrash // If true, then the NoteCollectionCounts.trashCount will be calculated // and supplied in the reply. Otherwise, the trash value will be omitted. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed // </li> // <li> BAD_DATA_FORMAT "NoteFilter.notebookGuids" - if any are malformed // </li> // <li> BAD_DATA_FORMAT "NoteFilter.words" - if search string too long // </li> // // @throws EDAMNotFoundException <ul> // <li> "Notebook.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Filter // - WithTrash FindNoteCounts(ctx context.Context, authenticationToken string, filter *NoteFilter, withTrash bool) (r *NoteCollectionCounts, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns the current state of the note in the service with the provided // GUID. The ENML contents of the note will only be provided if the // 'withContent' parameter is true. The service will include the meta-data // for each resource in the note, but the binary contents of the resources // and their recognition data will be omitted. // If the Note is found in a public notebook, the authenticationToken // will be ignored (so it could be an empty string). The applicationData // fields are returned as keysOnly. // // @param guid // The GUID of the note to be retrieved. // // @param withContent // If true, the note will include the ENML contents of its // 'content' field. // // @param withResourcesData // If true, any Resource elements in this Note will include the binary // contents of their 'data' field's body. // // @param withResourcesRecognition // If true, any Resource elements will include the binary contents of the // 'recognition' field's body if recognition data is present. // // @param withResourcesAlternateData // If true, any Resource elements in this Note will include the binary // contents of their 'alternateData' fields' body, if an alternate form // is present. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Note" - private note, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid // - WithContent // - WithResourcesData // - WithResourcesRecognition // - WithResourcesAlternateData GetNote(ctx context.Context, authenticationToken string, guid Types.Guid, withContent bool, withResourcesData bool, withResourcesRecognition bool, withResourcesAlternateData bool) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Get all of the application data for the note identified by GUID, // with values returned within the LazyMap fullMap field. // If there are no applicationData entries, then a LazyMap // with an empty fullMap will be returned. If your application // only needs to fetch its own applicationData entry, use // getNoteApplicationDataEntry instead. // // Parameters: // - AuthenticationToken // - Guid GetNoteApplicationData(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.LazyMap, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Get the value of a single entry in the applicationData map // for the note identified by GUID. // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - note not found, by GUID</li> // <li> "NoteAttributes.applicationData.key" - note not found, by key</li> // </ul> // // Parameters: // - AuthenticationToken // - Guid // - Key GetNoteApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Update, or create, an entry in the applicationData map for // the note identified by guid. // // Parameters: // - AuthenticationToken // - Guid // - Key // - Value SetNoteApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string, value string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Remove an entry identified by 'key' from the applicationData map for // the note identified by 'guid'. Silently ignores an unset of a // non-existing key. // // Parameters: // - AuthenticationToken // - Guid // - Key UnsetNoteApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns XHTML contents of the note with the provided GUID. // If the Note is found in a public notebook, the authenticationToken // will be ignored (so it could be an empty string). // // @param guid // The GUID of the note to be retrieved. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Note" - private note, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetNoteContent(ctx context.Context, authenticationToken string, guid Types.Guid) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns a block of the extracted plain text contents of the note with the // provided GUID. This text can be indexed for search purposes by a light // client that doesn't have capabilities to extract all of the searchable // text content from the note and its resources. // // If the Note is found in a public notebook, the authenticationToken // will be ignored (so it could be an empty string). // // @param guid // The GUID of the note to be retrieved. // // @param noteOnly // If true, this will only return the text extracted from the ENML contents // of the note itself. If false, this will also include the extracted text // from any text-bearing resources (PDF, recognized images) // // @param tokenizeForIndexing // If true, this will break the text into cleanly separated and sanitized // tokens. If false, this will return the more raw text extraction, with // its original punctuation, capitalization, spacing, etc. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Note" - private note, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid // - NoteOnly // - TokenizeForIndexing GetNoteSearchText(ctx context.Context, authenticationToken string, guid Types.Guid, noteOnly bool, tokenizeForIndexing bool) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns a block of the extracted plain text contents of the resource with // the provided GUID. This text can be indexed for search purposes by a light // client that doesn't have capability to extract all of the searchable // text content from a resource. // // If the Resource is found in a public notebook, the authenticationToken // will be ignored (so it could be an empty string). // // @param guid // The GUID of the resource to be retrieved. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Resource.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetResourceSearchText(ctx context.Context, authenticationToken string, guid Types.Guid) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns a list of the names of the tags for the note with the provided // guid. This can be used with authentication to get the tags for a // user's own note, or can be used without valid authentication to retrieve // the names of the tags for a note in a public notebook. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Note" - private note, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetNoteTagNames(ctx context.Context, authenticationToken string, guid Types.Guid) (r []string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Asks the service to make a note with the provided set of information. // // @param note // A Note object containing the desired fields to be populated on // the service. // // @return // The newly created Note from the service. The server-side // GUIDs for the Note and any Resources will be saved in this object. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.title" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "Note.content" - invalid length for ENML content // </li> // <li> BAD_DATA_FORMAT "Resource.mime" - invalid resource MIME type // </li> // <li> BAD_DATA_FORMAT "NoteAttributes.*" - bad resource string // </li> // <li> BAD_DATA_FORMAT "ResourceAttributes.*" - bad resource string // </li> // <li> DATA_CONFLICT "Note.deleted" - deleted time set on active note // </li> // <li> DATA_REQUIRED "Resource.data" - resource data body missing // </li> // <li> ENML_VALIDATION "*" - note content doesn't validate against DTD // </li> // <li> LIMIT_REACHED "Note" - at max number per account // </li> // <li> LIMIT_REACHED "Note.size" - total note size too large // </li> // <li> LIMIT_REACHED "Note.resources" - too many resources on Note // </li> // <li> LIMIT_REACHED "Note.tagGuids" - too many Tags on Note // </li> // <li> LIMIT_REACHED "Resource.data.size" - resource too large // </li> // <li> LIMIT_REACHED "NoteAttribute.*" - attribute string too long // </li> // <li> LIMIT_REACHED "ResourceAttribute.*" - attribute string too long // </li> // <li> PERMISSION_DENIED "Note.notebookGuid" - NB not owned by user // </li> // <li> QUOTA_REACHED "Accounting.uploadLimit" - note exceeds upload quota // </li> // <li> BAD_DATA_FORMAT "Tag.name" - Note.tagNames was provided, and one // of the specified tags had an invalid length or pattern // </li> // <li> LIMIT_REACHED "Tag" - Note.tagNames was provided, and the required // new tags would exceed the maximum number per account // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.notebookGuid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Note CreateNote(ctx context.Context, authenticationToken string, note *Types.Note) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Submit a set of changes to a note to the service. The provided data // must include the note's guid field for identification. The note's // title must also be set. // // @param note // A Note object containing the desired fields to be populated on // the service. With the exception of the note's title and guid, fields // that are not being changed do not need to be set. If the content is not // being modified, note.content should be left unset. If the list of // resources is not being modified, note.resources should be left unset. // // @return // The metadata (no contents) for the Note on the server after the update // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.title" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "Note.content" - invalid length for ENML body // </li> // <li> BAD_DATA_FORMAT "NoteAttributes.*" - bad resource string // </li> // <li> BAD_DATA_FORMAT "ResourceAttributes.*" - bad resource string // </li> // <li> BAD_DATA_FORMAT "Resource.mime" - invalid resource MIME type // </li> // <li> DATA_CONFLICT "Note.deleted" - deleted time set on active note // </li> // <li> DATA_REQUIRED "Resource.data" - resource data body missing // </li> // <li> ENML_VALIDATION "*" - note content doesn't validate against DTD // </li> // <li> LIMIT_REACHED "Note.tagGuids" - too many Tags on Note // </li> // <li> LIMIT_REACHED "Note.resources" - too many resources on Note // </li> // <li> LIMIT_REACHED "Note.size" - total note size too large // </li> // <li> LIMIT_REACHED "Resource.data.size" - resource too large // </li> // <li> LIMIT_REACHED "NoteAttribute.*" - attribute string too long // </li> // <li> LIMIT_REACHED "ResourceAttribute.*" - attribute string too long // </li> // <li> PERMISSION_DENIED "Note" - user doesn't own // </li> // <li> PERMISSION_DENIED "Note.notebookGuid" - user doesn't own destination // </li> // <li> QUOTA_REACHED "Accounting.uploadLimit" - note exceeds upload quota // </li> // <li> BAD_DATA_FORMAT "Tag.name" - Note.tagNames was provided, and one // of the specified tags had an invalid length or pattern // </li> // <li> LIMIT_REACHED "Tag" - Note.tagNames was provided, and the required // new tags would exceed the maximum number per account // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - note not found, by GUID // </li> // <li> "Note.notebookGuid" - if notebookGuid provided, but not found // </li> // </ul> // // Parameters: // - AuthenticationToken // - Note UpdateNote(ctx context.Context, authenticationToken string, note *Types.Note) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Moves the note into the trash. The note may still be undeleted, unless it // is expunged. This is equivalent to calling updateNote() after setting // Note.active = false // // @param guid // The GUID of the note to delete. // // @return // The Update Sequence Number for this change within the account. // // @throws EDAMUserException <ul> // <li> PERMISSION_DENIED "Note" - user doesn't have permission to // update the note. // </li> // </ul> // // @throws EDAMUserException <ul> // <li> DATA_CONFLICT "Note.guid" - the note is already deleted // </li> // </ul> // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid DeleteNote(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Permanently removes a Note, and all of its Resources, // from the service. // <p/> // NOTE: This function is not available to third party applications. // Calls will result in an EDAMUserException with the error code // PERMISSION_DENIED. // // @param guid // The GUID of the note to delete. // // @return // The Update Sequence Number for this change within the account. // // @throws EDAMUserException <ul> // <li> PERMISSION_DENIED "Note" - user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid ExpungeNote(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Permanently removes a list of Notes, and all of their Resources, from // the service. This should be invoked with a small number of Note GUIDs // (e.g. 100 or less) on each call. To expunge a larger number of notes, // call this method multiple times. This should also be used to reduce the // number of Notes in a notebook before calling expungeNotebook(ctx) or // in the trash before calling expungeInactiveNotes(ctx), since these calls may // be prohibitively slow if there are more than a few hundred notes. // If an exception is thrown for any of the GUIDs, then none of the notes // will be deleted. I.e. this call can be treated as an atomic transaction. // <p/> // NOTE: This function is not available to third party applications. // Calls will result in an EDAMUserException with the error code // PERMISSION_DENIED. // // @param noteGuids // The list of GUIDs for the Notes to remove. // // @return // The account's updateCount at the end of this operation // // @throws EDAMUserException <ul> // <li> PERMISSION_DENIED "Note" - user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - NoteGuids ExpungeNotes(ctx context.Context, authenticationToken string, noteGuids []Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Permanently removes all of the Notes that are currently marked as // inactive. This is equivalent to "emptying the trash", and these Notes // will be gone permanently. // <p/> // This operation may be relatively slow if the account contains a large // number of inactive Notes. // <p/> // NOTE: This function is not available to third party applications. // Calls will result in an EDAMUserException with the error code // PERMISSION_DENIED. // // @return // The number of notes that were expunged. // // Parameters: // - AuthenticationToken ExpungeInactiveNotes(ctx context.Context, authenticationToken string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error) // Performs a deep copy of the Note with the provided GUID 'noteGuid' into // the Notebook with the provided GUID 'toNotebookGuid'. // The caller must be the owner of both the Note and the Notebook. // This creates a new Note in the destination Notebook with new content and // Resources that match all of the content and Resources from the original // Note, but with new GUID identifiers. // The original Note is not modified by this operation. // The copied note is considered as an "upload" for the purpose of upload // transfer limit calculation, so its size is added to the upload count for // the owner. // // @param noteGuid // The GUID of the Note to copy. // // @param toNotebookGuid // The GUID of the Notebook that should receive the new Note. // // @return // The metadata for the new Note that was created. This will include the // new GUID for this Note (and any copied Resources), but will not include // the content body or the binary bodies of any Resources. // // @throws EDAMUserException <ul> // <li> LIMIT_REACHED "Note" - at max number per account // </li> // <li> PERMISSION_DENIED "Notebook.guid" - destination not owned by user // </li> // <li> PERMISSION_DENIED "Note" - user doesn't own // </li> // <li> QUOTA_REACHED "Accounting.uploadLimit" - note exceeds upload quota // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Notebook.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - NoteGuid // - ToNotebookGuid CopyNote(ctx context.Context, authenticationToken string, noteGuid Types.Guid, toNotebookGuid Types.Guid) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns a list of the prior versions of a particular note that are // saved within the service. These prior versions are stored to provide a // recovery from unintentional removal of content from a note. The identifiers // that are returned by this call can be used with getNoteVersion to retrieve // the previous note. // The identifiers will be listed from the most recent versions to the oldest. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Note" - private note, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - NoteGuid ListNoteVersions(ctx context.Context, authenticationToken string, noteGuid Types.Guid) (r []*NoteVersionId, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // This can be used to retrieve a previous version of a Note after it has been // updated within the service. The caller must identify the note (via its // guid) and the version (via the updateSequenceNumber of that version). // to find a listing of the stored version USNs for a note, call // listNoteVersions. // This call is only available for notes in Premium accounts. (I.e. access // to past versions of Notes is a Premium-only feature.) // // @param noteGuid // The GUID of the note to be retrieved. // // @param updateSequenceNum // The USN of the version of the note that is being retrieved // // @param withResourcesData // If true, any Resource elements in this Note will include the binary // contents of their 'data' field's body. // // @param withResourcesRecognition // If true, any Resource elements will include the binary contents of the // 'recognition' field's body if recognition data is present. // // @param withResourcesAlternateData // If true, any Resource elements in this Note will include the binary // contents of their 'alternateData' fields' body, if an alternate form // is present. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Note" - private note, user doesn't own // </li> // <li> PERMISSION_DENIED "updateSequenceNum" - // The account isn't permitted to access previous versions of notes. // (i.e. this is a Free account.) // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // <li> "Note.updateSequenceNumber" - the Note doesn't have a version with // the corresponding USN. // </li> // </ul> // // Parameters: // - AuthenticationToken // - NoteGuid // - UpdateSequenceNum // - WithResourcesData // - WithResourcesRecognition // - WithResourcesAlternateData GetNoteVersion(ctx context.Context, authenticationToken string, noteGuid Types.Guid, updateSequenceNum int32, withResourcesData bool, withResourcesRecognition bool, withResourcesAlternateData bool) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns the current state of the resource in the service with the // provided GUID. // If the Resource is found in a public notebook, the authenticationToken // will be ignored (so it could be an empty string). Only the // keys for the applicationData will be returned. // // @param guid // The GUID of the resource to be retrieved. // // @param withData // If true, the Resource will include the binary contents of the // 'data' field's body. // // @param withRecognition // If true, the Resource will include the binary contents of the // 'recognition' field's body if recognition data is present. // // @param withAttributes // If true, the Resource will include the attributes // // @param withAlternateData // If true, the Resource will include the binary contents of the // 'alternateData' field's body, if an alternate form is present. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Resource.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid // - WithData // - WithRecognition // - WithAttributes // - WithAlternateData GetResource(ctx context.Context, authenticationToken string, guid Types.Guid, withData bool, withRecognition bool, withAttributes bool, withAlternateData bool) (r *Types.Resource, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Get all of the application data for the Resource identified by GUID, // with values returned within the LazyMap fullMap field. // If there are no applicationData entries, then a LazyMap // with an empty fullMap will be returned. If your application // only needs to fetch its own applicationData entry, use // getResourceApplicationDataEntry instead. // // Parameters: // - AuthenticationToken // - Guid GetResourceApplicationData(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.LazyMap, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Get the value of a single entry in the applicationData map // for the Resource identified by GUID. // // @throws EDAMNotFoundException <ul> // <li> "Resource.guid" - Resource not found, by GUID</li> // <li> "ResourceAttributes.applicationData.key" - Resource not found, by key</li> // </ul> // // Parameters: // - AuthenticationToken // - Guid // - Key GetResourceApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Update, or create, an entry in the applicationData map for // the Resource identified by guid. // // Parameters: // - AuthenticationToken // - Guid // - Key // - Value SetResourceApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string, value string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Remove an entry identified by 'key' from the applicationData map for // the Resource identified by 'guid'. // // Parameters: // - AuthenticationToken // - Guid // - Key UnsetResourceApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Submit a set of changes to a resource to the service. This can be used // to update the meta-data about the resource, but cannot be used to change // the binary contents of the resource (including the length and hash). These // cannot be changed directly without creating a new resource and removing the // old one via updateNote. // // @param resource // A Resource object containing the desired fields to be populated on // the service. The service will attempt to update the resource with the // following fields from the client: // <ul> // <li>guid: must be provided to identify the resource // </li> // <li>mime // </li> // <li>width // </li> // <li>height // </li> // <li>duration // </li> // <li>attributes: optional. if present, the set of attributes will // be replaced. // </li> // </ul> // // @return // The Update Sequence Number of the resource after the changes have been // applied. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing // </li> // <li> BAD_DATA_FORMAT "Resource.mime" - invalid resource MIME type // </li> // <li> BAD_DATA_FORMAT "ResourceAttributes.*" - bad resource string // </li> // <li> LIMIT_REACHED "ResourceAttribute.*" - attribute string too long // </li> // <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Resource.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Resource UpdateResource(ctx context.Context, authenticationToken string, resource *Types.Resource) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns binary data of the resource with the provided GUID. For // example, if this were an image resource, this would contain the // raw bits of the image. // If the Resource is found in a public notebook, the authenticationToken // will be ignored (so it could be an empty string). // // @param guid // The GUID of the resource to be retrieved. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Resource.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetResourceData(ctx context.Context, authenticationToken string, guid Types.Guid) (r []byte, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns the current state of a resource, referenced by containing // note GUID and resource content hash. // // @param noteGuid // The GUID of the note that holds the resource to be retrieved. // // @param contentHash // The MD5 checksum of the resource within that note. Note that // this is the binary checksum, for example from Resource.data.bodyHash, // and not the hex-encoded checksum that is used within an en-media // tag in a note body. // // @param withData // If true, the Resource will include the binary contents of the // 'data' field's body. // // @param withRecognition // If true, the Resource will include the binary contents of the // 'recognition' field's body. // // @param withAlternateData // If true, the Resource will include the binary contents of the // 'alternateData' field's body, if an alternate form is present. // // @throws EDAMUserException <ul> // <li> DATA_REQUIRED "Note.guid" - noteGuid param missing // </li> // <li> DATA_REQUIRED "Note.contentHash" - contentHash param missing // </li> // <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note" - not found, by guid // </li> // <li> "Resource" - not found, by hash // </li> // </ul> // // Parameters: // - AuthenticationToken // - NoteGuid // - ContentHash // - WithData // - WithRecognition // - WithAlternateData GetResourceByHash(ctx context.Context, authenticationToken string, noteGuid Types.Guid, contentHash []byte, withData bool, withRecognition bool, withAlternateData bool) (r *Types.Resource, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns the binary contents of the recognition index for the resource // with the provided GUID. If the caller asks about a resource that has // no recognition data, this will throw EDAMNotFoundException. // If the Resource is found in a public notebook, the authenticationToken // will be ignored (so it could be an empty string). // // @param guid // The GUID of the resource whose recognition data should be retrieved. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Resource.guid" - not found, by GUID // </li> // <li> "Resource.recognition" - resource has no recognition // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetResourceRecognition(ctx context.Context, authenticationToken string, guid Types.Guid) (r []byte, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // If the Resource with the provided GUID has an alternate data representation // (indicated via the Resource.alternateData field), then this request can // be used to retrieve the binary contents of that alternate data file. // If the caller asks about a resource that has no alternate data form, this // will throw EDAMNotFoundException. // // @param guid // The GUID of the resource whose recognition data should be retrieved. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Resource.guid" - not found, by GUID // </li> // <li> "Resource.alternateData" - resource has no recognition // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetResourceAlternateData(ctx context.Context, authenticationToken string, guid Types.Guid) (r []byte, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // Returns the set of attributes for the Resource with the provided GUID. // If the Resource is found in a public notebook, the authenticationToken // will be ignored (so it could be an empty string). // // @param guid // The GUID of the resource whose attributes should be retrieved. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Resource.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid GetResourceAttributes(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.ResourceAttributes, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // <p> // Looks for a user account with the provided userId on this NoteStore // shard and determines whether that account contains a public notebook // with the given URI. If the account is not found, or no public notebook // exists with this URI, this will throw an EDAMNotFoundException, // otherwise this will return the information for that Notebook. // </p> // <p> // If a notebook is visible on the web with a full URL like // http://www.evernote.com/pub/sethdemo/api // Then 'sethdemo' is the username that can be used to look up the userId, // and 'api' is the publicUri. // </p> // // @param userId // The numeric identifier for the user who owns the public notebook. // To find this value based on a username string, you can invoke // UserStore.getPublicUserInfo // // @param publicUri // The uri string for the public notebook, from Notebook.publishing.uri. // // @throws EDAMNotFoundException <ul> // <li>"Publishing.uri" - not found, by URI</li> // </ul> // // @throws EDAMSystemException <ul> // <li> TAKEN_DOWN "PublicNotebook" - The specified public notebook is // taken down (for all requesters).</li> // <li> TAKEN_DOWN "Country" - The specified public notebook is taken // down for the requester because of an IP-based country lookup.</li> // </ul> // // Parameters: // - UserId // - PublicUri GetPublicNotebook(ctx context.Context, userId Types.UserID, publicUri string) (r *Types.Notebook, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) // contain a "share key" which serve as a unique identifer and access token // for a user to access the notebook of the shared notebook owner. // // @param sharedNotebook // A shared notebook object populated with the email address of the share // recipient, the notebook guid and the access permissions. All other // attributes of the shared object are ignored. The SharedNotebook.allowPreview // field must be explicitly set with either a true or false value. // // @return // The fully populated SharedNotebook object including the server assigned // share id and shareKey which can both be used to uniquely identify the // SharedNotebook. // // @throws EDAMUserException <ul> // <li>BAD_DATA_FORMAT "SharedNotebook.email" - if the email was not valid</li> // <li>BAD_DATA_FORMAT "requireLogin" - if the SharedNotebook.allowPreview field was // not set, and the SharedNotebook.requireLogin was also not set or was set to // false.</li> // <li>PERMISSION_DENIED "SharedNotebook.recipientSettings" - if // recipientSettings is set in the sharedNotebook. Only the recipient // can set these values via the setSharedNotebookRecipientSettings // method. // </li> // </ul> // @throws EDAMNotFoundException <ul> // <li>Notebook.guid - if the notebookGuid is not a valid GUID for the user. // </li> // </ul> // // Parameters: // - AuthenticationToken // - SharedNotebook CreateSharedNotebook(ctx context.Context, authenticationToken string, sharedNotebook *Types.SharedNotebook) (r *Types.SharedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // // @param authenticationToken // Must be an authentication token from the owner or a shared notebook // authentication token or business authentication token with sufficient // permissions to change invitations for a notebook. // // @param sharedNotebook // The SharedNotebook object containing the requested changes. // The "id" of the shared notebook must be set to allow the service // to identify the SharedNotebook to be updated. In addition, you MUST set // the email, permission, and allowPreview fields to the desired values. // All other fields will be ignored if set. // // @return // The Update Serial Number for this change within the account. // // @throws EDAMUserException <ul> // <li>UNSUPPORTED_OPERATION "updateSharedNotebook" - if this service instance does not support shared notebooks.</li> // <li>BAD_DATA_FORMAT "SharedNotebook.email" - if the email was not valid.</li> // <li>DATA_REQUIRED "SharedNotebook.id" - if the id field was not set.</li> // <li>DATA_REQUIRED "SharedNotebook.privilege" - if the privilege field was not set.</li> // <li>DATA_REQUIRED "SharedNotebook.allowPreview" - if the allowPreview field was not set.</li> // </ul> // @throws EDAMNotFoundException <ul> // <li>SharedNotebook.id - if no shared notebook with the specified ID was found. // </ul> // // Parameters: // - AuthenticationToken // - SharedNotebook UpdateSharedNotebook(ctx context.Context, authenticationToken string, sharedNotebook *Types.SharedNotebook) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // update rights to the shared notebook record itself has no effect on this call; // only the recipient of the shared notebook can can the recipient settings. // // If you do <i>not</i> wish to, or cannot, change one of the reminderNotifyEmail or // reminderNotifyInApp fields, you must leave that field unset in recipientSettings. // This method will skip that field for updates and leave the existing state as // it is. // // @return The update sequence number of the account to which the shared notebook // belongs, which is the account from which we are sharing a notebook. // // @throws EDAMNotFoundException "sharedNotebookId" - Thrown if the service does not // have a shared notebook record for the sharedNotebookId on the given shard. If you // receive this exception, it is probable that the shared notebook record has // been revoked or expired, or that you accessed the wrong shard. // // @throws EDAMUserException <ul> // <li>PEMISSION_DENIED "authenticationToken" - If you do not have permission to set // the recipient settings for the shared notebook. Only the recipient has // permission to do this. // <li>DATA_CONFLICT "recipientSettings.reminderNotifyEmail" - Setting whether // or not you want to receive reminder e-mail notifications is possible on // a business notebook in the business to which the user belongs. All // others can safely unset the reminderNotifyEmail field from the // recipientSettings parameter. // </ul> // // Parameters: // - AuthenticationToken // - SharedNotebookId // - RecipientSettings SetSharedNotebookRecipientSettings(ctx context.Context, authenticationToken string, sharedNotebookId int64, recipientSettings *Types.SharedNotebookRecipientSettings) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // shared with. The message includes the current link to view the notebook. // @param authenticationToken // The auth token of the user with permissions to share the notebook // @param notebookGuid // The guid of the shared notebook // @param messageText // User provided text to include in the email // @param recipients // The email addresses of the recipients. If this list is empty then all of the // users that the notebook has been shared with are emailed. // If an email address doesn't correspond to share invite members then that address // is ignored. // @return // The number of messages sent // @throws EDAMUserException <ul> // <li> LIMIT_REACHED "(recipients)" - // The email can't be sent because this would exceed the user's daily // email limit. // </li> // <li> PERMISSION_DENIED "Notebook.guid" - The user doesn't have permission to // send a message for the specified notebook. // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Notebook.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - NotebookGuid // - MessageText // - Recipients SendMessageToSharedNotebookMembers(ctx context.Context, authenticationToken string, notebookGuid Types.Guid, messageText string, recipients []string) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // users account. // // @return // The list of all SharedNotebooks for the user // // Parameters: // - AuthenticationToken ListSharedNotebooks(ctx context.Context, authenticationToken string) (r []*Types.SharedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // SharedNotebook.id as the identifier. // <p/> // NOTE: This function is generally not available to third party applications. // Calls will result in an EDAMUserException with the error code // PERMISSION_DENIED. // // @param // sharedNotebookIds - a list of ShardNotebook.id longs identifying the // objects to delete permanently. // // @return // The account's update sequence number. // // Parameters: // - AuthenticationToken // - SharedNotebookIds ExpungeSharedNotebooks(ctx context.Context, authenticationToken string, sharedNotebookIds []int64) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // Asks the service to make a linked notebook with the provided name, username // of the owner and identifiers provided. A linked notebook can be either a // link to a public notebook or to a private shared notebook. // // @param linkedNotebook // The desired fields for the linked notebook must be provided on this // object. The name of the linked notebook must be set. Either a username // uri or a shard id and share key must be provided otherwise a // EDAMUserException is thrown. // // @return // The newly created LinkedNotebook. The server-side id will be // saved in this object's 'id' field. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "LinkedNotebook.name" - invalid length or pattern // </li> // <li> BAD_DATA_FORMAT "LinkedNotebook.username" - bad username format // </li> // <li> BAD_DATA_FORMAT "LinkedNotebook.uri" - // if public notebook set but bad uri // </li> // <li> BAD_DATA_FORMAT "LinkedNotebook.shareKey" - // if private notebook set but bad shareKey // </li> // <li> DATA_REQUIRED "LinkedNotebook.shardId" - // if private notebook but shard id not provided // </li> // </ul> // // Parameters: // - AuthenticationToken // - LinkedNotebook CreateLinkedNotebook(ctx context.Context, authenticationToken string, linkedNotebook *Types.LinkedNotebook) (r *Types.LinkedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // @param linkedNotebook // Updates the name of a linked notebook. // // @return // The Update Sequence Number for this change within the account. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "LinkedNotebook.name" - invalid length or pattern // </li> // </ul> // // Parameters: // - AuthenticationToken // - LinkedNotebook UpdateLinkedNotebook(ctx context.Context, authenticationToken string, linkedNotebook *Types.LinkedNotebook) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // Returns a list of linked notebooks // // Parameters: // - AuthenticationToken ListLinkedNotebooks(ctx context.Context, authenticationToken string) (r []*Types.LinkedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // Permanently expunges the linked notebook from the account. // <p/> // NOTE: This function is generally not available to third party applications. // Calls will result in an EDAMUserException with the error code // PERMISSION_DENIED. // // @param guid // The LinkedNotebook.guid field of the LinkedNotebook to permanently remove // from the account. // // Parameters: // - AuthenticationToken // - Guid ExpungeLinkedNotebook(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // access the contents of a shared notebook from someone else's account. // This authenticationToken can be used with the various other NoteStore // calls to find and retrieve notes, and if the permissions in the shared // notebook are sufficient, to make changes to the contents of the notebook. // // @param shareKey // The 'shareKey' identifier from the SharedNotebook that was granted to // some recipient. This string internally encodes the notebook identifier // and a security signature. // // @param authenticationToken // If a non-empty string is provided, this is the full user-based // authentication token that identifies the user who is currently logged in // and trying to access the shared notebook. This may be required if the // notebook was created with 'requireLogin'. // If this string is empty, the service will attempt to authenticate to the // shared notebook without any logged in user. // // @throws EDAMSystemException <ul> // <li> BAD_DATA_FORMAT "shareKey" - invalid shareKey string // </li> // <li> INVALID_AUTH "shareKey" - bad signature on shareKey string // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "SharedNotebook.id" - the shared notebook no longer exists // </li> // </ul> // // @throws EDAMUserException <ul> // <li> DATA_REQUIRED "authenticationToken" - the share requires login, and // no valid authentication token was provided. // </li> // <li> PERMISSION_DENIED "SharedNotebook.username" - share requires login, // and another username has already been bound to this notebook. // </li> // </ul> // // Parameters: // - ShareKey // - AuthenticationToken AuthenticateToSharedNotebook(ctx context.Context, shareKey string, authenticationToken string) (r *UserStore.AuthenticationResult, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // notebook by a guest who has already authenticated to access that notebook. // This requires an 'authenticationToken' parameter which should be the // resut of a call to authenticateToSharedNotebook(...). // I.e. this is the token that gives access to the particular shared notebook // in someone else's account -- it's not the authenticationToken for the // owner of the notebook itself. // // @param authenticationToken // Should be the authentication token retrieved from the reply of // authenticateToSharedNotebook(ctx), proving access to a particular shared // notebook. // // @throws EDAMUserException <ul> // <li> PERMISSION_DENIED "authenticationToken" - // authentication token doesn't correspond to a valid shared notebook // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "SharedNotebook.id" - the shared notebook no longer exists // </li> // </ul> // // Parameters: // - AuthenticationToken GetSharedNotebookByAuth(ctx context.Context, authenticationToken string) (r *Types.SharedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // Attempts to send a single note to one or more email recipients. // <p/> // NOTE: This function is generally not available to third party applications. // Calls will result in an EDAMUserException with the error code // PERMISSION_DENIED. // // @param authenticationToken // The note will be sent as the user logged in via this token, using that // user's registered email address. If the authenticated user doesn't // have permission to read that note, the emailing will fail. // // @param parameters // The note must be specified either by GUID (in which case it will be // sent using the existing data in the service), or else the full Note // must be passed to this call. This also specifies the additional // email fields that will be used in the email. // // @throws EDAMUserException <ul> // <li> LIMIT_REACHED "NoteEmailParameters.toAddresses" - // The email can't be sent because this would exceed the user's daily // email limit. // </li> // <li> BAD_DATA_FORMAT "(email address)" - // email address malformed // </li> // <li> DATA_REQUIRED "NoteEmailParameters.toAddresses" - // if there are no To: or Cc: addresses provided. // </li> // <li> DATA_REQUIRED "Note.title" - // if the caller provides a Note parameter with no title // </li> // <li> DATA_REQUIRED "Note.content" - // if the caller provides a Note parameter with no content // </li> // <li> ENML_VALIDATION "*" - note content doesn't validate against DTD // </li> // <li> DATA_REQUIRED "NoteEmailParameters.note" - // if no guid or note provided // </li> // <li> PERMISSION_DENIED "Note" - private note, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Parameters EmailNote(ctx context.Context, authenticationToken string, parameters *NoteEmailParameters) (userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // will start sharing that note. // This will return the secret "Note Key" for this note that // can currently be used in conjunction with the Note's GUID to gain direct // read-only access to the Note. // If the note is already shared, then this won't make any changes to the // note, and the existing "Note Key" will be returned. The only way to change // the Note Key for an existing note is to stopSharingNote first, and then // call this function. // // @param guid // The GUID of the note to be shared. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Note" - private note, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid ShareNote(ctx context.Context, authenticationToken string, guid Types.Guid) (r string, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // If this note is not already shared then this will stop sharing that note // and invalidate its "Note Key", so any existing URLs to access that Note // will stop working. // If the Note is not shared, then this function will do nothing. // // @param guid // The GUID of the note to be un-shared. // // @throws EDAMUserException <ul> // <li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing // </li> // <li> PERMISSION_DENIED "Note" - private note, user doesn't own // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "Note.guid" - not found, by GUID // </li> // </ul> // // Parameters: // - AuthenticationToken // - Guid StopSharingNote(ctx context.Context, authenticationToken string, guid Types.Guid) (userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // access the contents of a single Note which was individually shared // from someone's account. // This authenticationToken can be used with the various other NoteStore // calls to find and retrieve the Note and its directly-referenced children. // // @param guid // The GUID identifying this Note on this shard. // // @param noteKey // The 'noteKey' identifier from the Note that was originally created via // a call to shareNote() and then given to a recipient to access. // // @param authenticationToken // An optional authenticationToken that identifies the user accessing the // shared note. This parameter may be required to access some shared notes. // // @throws EDAMUserException <ul> // <li> PERMISSION_DENIED "Note" - the Note with that GUID is either not // shared, or the noteKey doesn't match the current key for this note // </li> // <li> PERMISSION_DENIED "authenticationToken" - an authentication token is // required to access this Note, but either no authentication token or a // "non-owner" authentication token was provided. // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li> "guid" - the note with that GUID is not found // </li> // </ul> // // @throws EDAMSystemException <ul> // <li> TAKEN_DOWN "Note" - The specified shared note is taken down (for // all requesters). // </li> // <li> TAKEN_DOWN "Country" - The specified shared note is taken down // for the requester because of an IP-based country lookup. // </ul> // </ul> // // Parameters: // - Guid // - NoteKey // - AuthenticationToken AuthenticateToSharedNote(ctx context.Context, guid string, noteKey string, authenticationToken string) (r *UserStore.AuthenticationResult, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error) // Identify related entities on the service, such as notes, // notebooks, and tags related to notes or content. // // @param query // The information about which we are finding related entities. // // @param resultSpec // Allows the client to indicate the type and quantity of // information to be returned, allowing a saving of time and // bandwidth. // // @return // The result of the query, with information considered // to likely be relevantly related to the information // described by the query. // // @throws EDAMUserException <ul> // <li>BAD_DATA_FORMAT "RelatedQuery.plainText" - If you provided a // a zero-length plain text value. // </li> // <li>BAD_DATA_FORMAT "RelatedQuery.noteGuid" - If you provided an // invalid Note GUID, that is, one that does not match the constraints // defined by EDAM_GUID_LEN_MIN, EDAM_GUID_LEN_MAX, EDAM_GUID_REGEX. // </li> // <li> BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed // </li> // <li> BAD_DATA_FORMAT "NoteFilter.tagGuids" - if any are malformed // </li> // <li> BAD_DATA_FORMAT "NoteFilter.words" - if search string too long // </li> // <li>PERMISSION_DENIED "Note" - If the caller does not have access to // the note identified by RelatedQuery.noteGuid. // </li> // <li>DATA_REQUIRED "RelatedResultSpec" - If you did not not set any values // in the result spec. // </li> // </ul> // // @throws EDAMNotFoundException <ul> // <li>"RelatedQuery.noteGuid" - the note with that GUID is not // found, if that field has been set in the query. // </li> // </ul> // // Parameters: // - AuthenticationToken // - Query // - ResultSpec FindRelated(ctx context.Context, authenticationToken string, query *RelatedQuery, resultSpec *RelatedResultSpec) (r *RelatedResult, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error) }
type NoteStoreClient ¶
type NoteStoreClient struct { Transport thrift.TTransport ProtocolFactory thrift.TProtocolFactory InputProtocol thrift.TProtocol OutputProtocol thrift.TProtocol SeqId int32 }
func NewNoteStoreClientFactory ¶
func NewNoteStoreClientFactory(t thrift.TTransport, f thrift.TProtocolFactory) *NoteStoreClient
func NewNoteStoreClientProtocol ¶
func NewNoteStoreClientProtocol(t thrift.TTransport, iprot thrift.TProtocol, oprot thrift.TProtocol) *NoteStoreClient
func (*NoteStoreClient) AuthenticateToSharedNote ¶
func (p *NoteStoreClient) AuthenticateToSharedNote(ctx context.Context, guid string, noteKey string, authenticationToken string) (r *UserStore.AuthenticationResult, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Asks the service to produce an authentication token that can be used to access the contents of a single Note which was individually shared from someone's account. This authenticationToken can be used with the various other NoteStore calls to find and retrieve the Note and its directly-referenced children.
@param guid
The GUID identifying this Note on this shard.
@param noteKey
The 'noteKey' identifier from the Note that was originally created via a call to shareNote() and then given to a recipient to access.
@param authenticationToken
An optional authenticationToken that identifies the user accessing the shared note. This parameter may be required to access some shared notes.
@throws EDAMUserException <ul>
<li> PERMISSION_DENIED "Note" - the Note with that GUID is either not shared, or the noteKey doesn't match the current key for this note </li> <li> PERMISSION_DENIED "authenticationToken" - an authentication token is required to access this Note, but either no authentication token or a "non-owner" authentication token was provided. </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "guid" - the note with that GUID is not found </li>
</ul>
@throws EDAMSystemException <ul>
<li> TAKEN_DOWN "Note" - The specified shared note is taken down (for all requesters). </li> <li> TAKEN_DOWN "Country" - The specified shared note is taken down for the requester because of an IP-based country lookup. </ul>
</ul>
Parameters:
- Guid
- NoteKey
- AuthenticationToken
func (*NoteStoreClient) AuthenticateToSharedNotebook ¶
func (p *NoteStoreClient) AuthenticateToSharedNotebook(ctx context.Context, shareKey string, authenticationToken string) (r *UserStore.AuthenticationResult, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Asks the service to produce an authentication token that can be used to access the contents of a shared notebook from someone else's account. This authenticationToken can be used with the various other NoteStore calls to find and retrieve notes, and if the permissions in the shared notebook are sufficient, to make changes to the contents of the notebook.
@param shareKey
The 'shareKey' identifier from the SharedNotebook that was granted to some recipient. This string internally encodes the notebook identifier and a security signature.
@param authenticationToken
If a non-empty string is provided, this is the full user-based authentication token that identifies the user who is currently logged in and trying to access the shared notebook. This may be required if the notebook was created with 'requireLogin'. If this string is empty, the service will attempt to authenticate to the shared notebook without any logged in user.
@throws EDAMSystemException <ul>
<li> BAD_DATA_FORMAT "shareKey" - invalid shareKey string </li> <li> INVALID_AUTH "shareKey" - bad signature on shareKey string </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "SharedNotebook.id" - the shared notebook no longer exists </li>
</ul>
@throws EDAMUserException <ul>
<li> DATA_REQUIRED "authenticationToken" - the share requires login, and no valid authentication token was provided. </li> <li> PERMISSION_DENIED "SharedNotebook.username" - share requires login, and another username has already been bound to this notebook. </li>
</ul>
Parameters:
- ShareKey
- AuthenticationToken
func (*NoteStoreClient) CopyNote ¶
func (p *NoteStoreClient) CopyNote(ctx context.Context, authenticationToken string, noteGuid Types.Guid, toNotebookGuid Types.Guid) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Performs a deep copy of the Note with the provided GUID 'noteGuid' into the Notebook with the provided GUID 'toNotebookGuid'. The caller must be the owner of both the Note and the Notebook. This creates a new Note in the destination Notebook with new content and Resources that match all of the content and Resources from the original Note, but with new GUID identifiers. The original Note is not modified by this operation. The copied note is considered as an "upload" for the purpose of upload transfer limit calculation, so its size is added to the upload count for the owner.
@param noteGuid
The GUID of the Note to copy.
@param toNotebookGuid
The GUID of the Notebook that should receive the new Note.
@return
The metadata for the new Note that was created. This will include the new GUID for this Note (and any copied Resources), but will not include the content body or the binary bodies of any Resources.
@throws EDAMUserException <ul>
<li> LIMIT_REACHED "Note" - at max number per account </li> <li> PERMISSION_DENIED "Notebook.guid" - destination not owned by user </li> <li> PERMISSION_DENIED "Note" - user doesn't own </li> <li> QUOTA_REACHED "Accounting.uploadLimit" - note exceeds upload quota </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Notebook.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- NoteGuid
- ToNotebookGuid
func (*NoteStoreClient) CreateLinkedNotebook ¶
func (p *NoteStoreClient) CreateLinkedNotebook(ctx context.Context, authenticationToken string, linkedNotebook *Types.LinkedNotebook) (r *Types.LinkedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Asks the service to make a linked notebook with the provided name, username of the owner and identifiers provided. A linked notebook can be either a link to a public notebook or to a private shared notebook.
@param linkedNotebook
The desired fields for the linked notebook must be provided on this object. The name of the linked notebook must be set. Either a username uri or a shard id and share key must be provided otherwise a EDAMUserException is thrown.
@return
The newly created LinkedNotebook. The server-side id will be saved in this object's 'id' field.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "LinkedNotebook.name" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "LinkedNotebook.username" - bad username format </li> <li> BAD_DATA_FORMAT "LinkedNotebook.uri" - if public notebook set but bad uri </li> <li> BAD_DATA_FORMAT "LinkedNotebook.shareKey" - if private notebook set but bad shareKey </li> <li> DATA_REQUIRED "LinkedNotebook.shardId" - if private notebook but shard id not provided </li>
</ul>
Parameters:
- AuthenticationToken
- LinkedNotebook
func (*NoteStoreClient) CreateNote ¶
func (p *NoteStoreClient) CreateNote(ctx context.Context, authenticationToken string, note *Types.Note) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Asks the service to make a note with the provided set of information.
@param note
A Note object containing the desired fields to be populated on the service.
@return
The newly created Note from the service. The server-side GUIDs for the Note and any Resources will be saved in this object.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.title" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "Note.content" - invalid length for ENML content </li> <li> BAD_DATA_FORMAT "Resource.mime" - invalid resource MIME type </li> <li> BAD_DATA_FORMAT "NoteAttributes.*" - bad resource string </li> <li> BAD_DATA_FORMAT "ResourceAttributes.*" - bad resource string </li> <li> DATA_CONFLICT "Note.deleted" - deleted time set on active note </li> <li> DATA_REQUIRED "Resource.data" - resource data body missing </li> <li> ENML_VALIDATION "*" - note content doesn't validate against DTD </li> <li> LIMIT_REACHED "Note" - at max number per account </li> <li> LIMIT_REACHED "Note.size" - total note size too large </li> <li> LIMIT_REACHED "Note.resources" - too many resources on Note </li> <li> LIMIT_REACHED "Note.tagGuids" - too many Tags on Note </li> <li> LIMIT_REACHED "Resource.data.size" - resource too large </li> <li> LIMIT_REACHED "NoteAttribute.*" - attribute string too long </li> <li> LIMIT_REACHED "ResourceAttribute.*" - attribute string too long </li> <li> PERMISSION_DENIED "Note.notebookGuid" - NB not owned by user </li> <li> QUOTA_REACHED "Accounting.uploadLimit" - note exceeds upload quota </li> <li> BAD_DATA_FORMAT "Tag.name" - Note.tagNames was provided, and one of the specified tags had an invalid length or pattern </li> <li> LIMIT_REACHED "Tag" - Note.tagNames was provided, and the required new tags would exceed the maximum number per account </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.notebookGuid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Note
func (*NoteStoreClient) CreateNotebook ¶
func (p *NoteStoreClient) CreateNotebook(ctx context.Context, authenticationToken string, notebook *Types.Notebook) (r *Types.Notebook, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Asks the service to make a notebook with the provided name.
@param notebook
The desired fields for the notebook must be provided on this object. The name of the notebook must be set, and either the 'active' or 'defaultNotebook' fields may be set by the client at creation. If a notebook exists in the account with the same name (via case-insensitive compare), this will throw an EDAMUserException.
@return
The newly created Notebook. The server-side GUID will be saved in this object's 'guid' field.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Notebook.name" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "Notebook.stack" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "Publishing.uri" - if publishing set but bad uri </li> <li> BAD_DATA_FORMAT "Publishing.publicDescription" - if too long </li> <li> DATA_CONFLICT "Notebook.name" - name already in use </li> <li> DATA_CONFLICT "Publishing.uri" - if URI already in use </li> <li> DATA_REQUIRED "Publishing.uri" - if publishing set but uri missing </li> <li> LIMIT_REACHED "Notebook" - at max number of notebooks </li>
</ul>
Parameters:
- AuthenticationToken
- Notebook
func (*NoteStoreClient) CreateSearch ¶
func (p *NoteStoreClient) CreateSearch(ctx context.Context, authenticationToken string, search *Types.SavedSearch) (r *Types.SavedSearch, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Asks the service to make a saved search with a set of information.
@param search
The desired list of fields for the search are specified in this object. The caller must specify the name and query for the search, and may optionally specify a search scope. The SavedSearch.format field is ignored by the service.
@return
The newly created SavedSearch. The server-side GUID will be saved in this object.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "SavedSearch.name" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "SavedSearch.query" - invalid length </li> <li> DATA_CONFLICT "SavedSearch.name" - name already in use </li> <li> LIMIT_REACHED "SavedSearch" - at max number of searches </li>
</ul>
Parameters:
- AuthenticationToken
- Search
func (*NoteStoreClient) CreateSharedNotebook ¶
func (p *NoteStoreClient) CreateSharedNotebook(ctx context.Context, authenticationToken string, sharedNotebook *Types.SharedNotebook) (r *Types.SharedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Used to construct a shared notebook object. The constructed notebook will contain a "share key" which serve as a unique identifer and access token for a user to access the notebook of the shared notebook owner.
@param sharedNotebook
A shared notebook object populated with the email address of the share recipient, the notebook guid and the access permissions. All other attributes of the shared object are ignored. The SharedNotebook.allowPreview field must be explicitly set with either a true or false value.
@return
The fully populated SharedNotebook object including the server assigned share id and shareKey which can both be used to uniquely identify the SharedNotebook.
@throws EDAMUserException <ul>
<li>BAD_DATA_FORMAT "SharedNotebook.email" - if the email was not valid</li> <li>BAD_DATA_FORMAT "requireLogin" - if the SharedNotebook.allowPreview field was not set, and the SharedNotebook.requireLogin was also not set or was set to false.</li> <li>PERMISSION_DENIED "SharedNotebook.recipientSettings" - if recipientSettings is set in the sharedNotebook. Only the recipient can set these values via the setSharedNotebookRecipientSettings method. </li> </ul>
@throws EDAMNotFoundException <ul>
<li>Notebook.guid - if the notebookGuid is not a valid GUID for the user. </li> </ul>
Parameters:
- AuthenticationToken
- SharedNotebook
func (*NoteStoreClient) CreateTag ¶
func (p *NoteStoreClient) CreateTag(ctx context.Context, authenticationToken string, tag *Types.Tag) (r *Types.Tag, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Asks the service to make a tag with a set of information.
@param tag
The desired list of fields for the tag are specified in this object. The caller must specify the tag name, and may provide the parentGUID.
@return
The newly created Tag. The server-side GUID will be saved in this object.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Tag.name" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "Tag.parentGuid" - malformed GUID </li> <li> DATA_CONFLICT "Tag.name" - name already in use </li> <li> LIMIT_REACHED "Tag" - at max number of tags </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Tag.parentGuid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Tag
func (*NoteStoreClient) DeleteNote ¶
func (p *NoteStoreClient) DeleteNote(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Moves the note into the trash. The note may still be undeleted, unless it is expunged. This is equivalent to calling updateNote() after setting Note.active = false
@param guid
The GUID of the note to delete.
@return
The Update Sequence Number for this change within the account.
@throws EDAMUserException <ul>
<li> PERMISSION_DENIED "Note" - user doesn't have permission to update the note. </li>
</ul>
@throws EDAMUserException <ul>
<li> DATA_CONFLICT "Note.guid" - the note is already deleted </li>
</ul> @throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) EmailNote ¶
func (p *NoteStoreClient) EmailNote(ctx context.Context, authenticationToken string, parameters *NoteEmailParameters) (userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Attempts to send a single note to one or more email recipients. <p/> NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
@param authenticationToken
The note will be sent as the user logged in via this token, using that user's registered email address. If the authenticated user doesn't have permission to read that note, the emailing will fail.
@param parameters
The note must be specified either by GUID (in which case it will be sent using the existing data in the service), or else the full Note must be passed to this call. This also specifies the additional email fields that will be used in the email.
@throws EDAMUserException <ul>
<li> LIMIT_REACHED "NoteEmailParameters.toAddresses" - The email can't be sent because this would exceed the user's daily email limit. </li> <li> BAD_DATA_FORMAT "(email address)" - email address malformed </li> <li> DATA_REQUIRED "NoteEmailParameters.toAddresses" - if there are no To: or Cc: addresses provided. </li> <li> DATA_REQUIRED "Note.title" - if the caller provides a Note parameter with no title </li> <li> DATA_REQUIRED "Note.content" - if the caller provides a Note parameter with no content </li> <li> ENML_VALIDATION "*" - note content doesn't validate against DTD </li> <li> DATA_REQUIRED "NoteEmailParameters.note" - if no guid or note provided </li> <li> PERMISSION_DENIED "Note" - private note, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Parameters
func (*NoteStoreClient) ExpungeInactiveNotes ¶
func (p *NoteStoreClient) ExpungeInactiveNotes(ctx context.Context, authenticationToken string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Permanently removes all of the Notes that are currently marked as inactive. This is equivalent to "emptying the trash", and these Notes will be gone permanently. <p/> This operation may be relatively slow if the account contains a large number of inactive Notes. <p/> NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
@return
The number of notes that were expunged.
Parameters:
- AuthenticationToken
func (*NoteStoreClient) ExpungeLinkedNotebook ¶
func (p *NoteStoreClient) ExpungeLinkedNotebook(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Permanently expunges the linked notebook from the account. <p/> NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
@param guid
The LinkedNotebook.guid field of the LinkedNotebook to permanently remove from the account.
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) ExpungeNote ¶
func (p *NoteStoreClient) ExpungeNote(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Permanently removes a Note, and all of its Resources, from the service. <p/> NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
@param guid
The GUID of the note to delete.
@return
The Update Sequence Number for this change within the account.
@throws EDAMUserException <ul>
<li> PERMISSION_DENIED "Note" - user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) ExpungeNotebook ¶
func (p *NoteStoreClient) ExpungeNotebook(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Permanently removes the notebook from the user's account. After this action, the notebook is no longer available for undeletion, etc. If the notebook contains any Notes, they will be moved to the current default notebook and moved into the trash (i.e. Note.active=false). <p/> NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
@param guid
The GUID of the notebook to delete.
@return
The Update Sequence Number for this change within the account.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Notebook.guid" - if the parameter is missing </li> <li> LIMIT_REACHED "Notebook" - trying to expunge the last Notebook </li> <li> PERMISSION_DENIED "Notebook" - private notebook, user doesn't own </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) ExpungeNotes ¶
func (p *NoteStoreClient) ExpungeNotes(ctx context.Context, authenticationToken string, noteGuids []Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Permanently removes a list of Notes, and all of their Resources, from the service. This should be invoked with a small number of Note GUIDs (e.g. 100 or less) on each call. To expunge a larger number of notes, call this method multiple times. This should also be used to reduce the number of Notes in a notebook before calling expungeNotebook(ctx) or in the trash before calling expungeInactiveNotes(ctx), since these calls may be prohibitively slow if there are more than a few hundred notes. If an exception is thrown for any of the GUIDs, then none of the notes will be deleted. I.e. this call can be treated as an atomic transaction. <p/> NOTE: This function is not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
@param noteGuids
The list of GUIDs for the Notes to remove.
@return
The account's updateCount at the end of this operation
@throws EDAMUserException <ul>
<li> PERMISSION_DENIED "Note" - user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- NoteGuids
func (*NoteStoreClient) ExpungeSearch ¶
func (p *NoteStoreClient) ExpungeSearch(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Permanently deletes the saved search with the provided GUID, if present. <p/> NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
@param guid
The GUID of the search to delete.
@return
The Update Sequence Number for this change within the account.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "SavedSearch.guid" - if the guid parameter is empty </li> <li> PERMISSION_DENIED "SavedSearch" - user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "SavedSearch.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) ExpungeSharedNotebooks ¶
func (p *NoteStoreClient) ExpungeSharedNotebooks(ctx context.Context, authenticationToken string, sharedNotebookIds []int64) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Expunges the SharedNotebooks in the user's account using the SharedNotebook.id as the identifier. <p/> NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
@param
sharedNotebookIds - a list of ShardNotebook.id longs identifying the objects to delete permanently.
@return
The account's update sequence number.
Parameters:
- AuthenticationToken
- SharedNotebookIds
func (*NoteStoreClient) ExpungeTag ¶
func (p *NoteStoreClient) ExpungeTag(ctx context.Context, authenticationToken string, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Permanently deletes the tag with the provided GUID, if present. <p/> NOTE: This function is generally not available to third party applications. Calls will result in an EDAMUserException with the error code PERMISSION_DENIED.
@param guid
The GUID of the tag to delete.
@return
The Update Sequence Number for this change within the account.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Tag.guid" - if the guid parameter is missing </li> <li> PERMISSION_DENIED "Tag" - user doesn't own tag </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Tag.guid" - tag not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) FindNoteCounts ¶
func (p *NoteStoreClient) FindNoteCounts(ctx context.Context, authenticationToken string, filter *NoteFilter, withTrash bool) (r *NoteCollectionCounts, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
This function is used to determine how many notes are found for each notebook and tag in the user's account, given a current set of filter parameters that determine the current selection. This function will return a structure that gives the note count for each notebook and tag that has at least one note under the requested filter. Any notebook or tag that has zero notes in the filtered set will not be listed in the reply to this function (so they can be assumed to be 0).
@param authenticationToken
Must be a valid token for the user's account unless the NoteFilter 'notebookGuid' is the GUID of a public notebook.
@param filter
The note selection filter that is currently being applied. The note counts are to be calculated with this filter applied to the total set of notes in the user's account.
@param withTrash
If true, then the NoteCollectionCounts.trashCount will be calculated and supplied in the reply. Otherwise, the trash value will be omitted.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed </li> <li> BAD_DATA_FORMAT "NoteFilter.notebookGuids" - if any are malformed </li> <li> BAD_DATA_FORMAT "NoteFilter.words" - if search string too long </li>
@throws EDAMNotFoundException <ul>
<li> "Notebook.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Filter
- WithTrash
func (*NoteStoreClient) FindNoteOffset ¶
func (p *NoteStoreClient) FindNoteOffset(ctx context.Context, authenticationToken string, filter *NoteFilter, guid Types.Guid) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Finds the position of a note within a sorted subset of all of the user's notes. This may be useful for thin clients that are displaying a paginated listing of a large account, which need to know where a particular note sits in the list without retrieving all notes first.
@param authenticationToken
Must be a valid token for the user's account unless the NoteFilter 'notebookGuid' is the GUID of a public notebook.
@param filter
The list of criteria that will constrain the notes to be returned.
@param guid
The GUID of the note to be retrieved.
@return
If the note with the provided GUID is found within the matching note list, this will return the offset of that note within that list (where the first offset is 0). If the note is not found within the set of notes, this will return -1.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "offset" - not between 0 and EDAM_USER_NOTES_MAX </li> <li> BAD_DATA_FORMAT "maxNotes" - not between 0 and EDAM_USER_NOTES_MAX </li> <li> BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed </li> <li> BAD_DATA_FORMAT "NoteFilter.tagGuids" - if any are malformed </li> <li> BAD_DATA_FORMAT "NoteFilter.words" - if search string too long </li>
@throws EDAMNotFoundException <ul>
<li> "Notebook.guid" - not found, by GUID </li> <li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Filter
- Guid
func (*NoteStoreClient) FindNotes ¶
func (p *NoteStoreClient) FindNotes(ctx context.Context, authenticationToken string, filter *NoteFilter, offset int32, maxNotes int32) (r *NoteList, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
DEPRECATED. Use findNotesMetadata.
Parameters:
- AuthenticationToken
- Filter
- Offset
- MaxNotes
func (*NoteStoreClient) FindNotesMetadata ¶
func (p *NoteStoreClient) FindNotesMetadata(ctx context.Context, authenticationToken string, filter *NoteFilter, offset int32, maxNotes int32, resultSpec *NotesMetadataResultSpec) (r *NotesMetadataList, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Used to find the high-level information about a set of the notes from a user's account based on various criteria specified via a NoteFilter object. <p/> Web applications that wish to periodically check for new content in a user's Evernote account should consider using webhooks instead of polling this API. See http://dev.evernote.com/documentation/cloud/chapters/polling_notification.php for more information.
@param authenticationToken
Must be a valid token for the user's account unless the NoteFilter 'notebookGuid' is the GUID of a public notebook.
@param filter
The list of criteria that will constrain the notes to be returned.
@param offset
The numeric index of the first note to show within the sorted results. The numbering scheme starts with "0". This can be used for pagination.
@param maxNotes
The mximum notes to return in this query. The service will return a set of notes that is no larger than this number, but may return fewer notes if needed. The NoteList.totalNotes field in the return value will indicate whether there are more values available after the returned set.
@param resultSpec
This specifies which information should be returned for each matching Note. The fields on this structure can be used to eliminate data that the client doesn't need, which will reduce the time and bandwidth to receive and process the reply.
@return
The list of notes that match the criteria.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "offset" - not between 0 and EDAM_USER_NOTES_MAX </li> <li> BAD_DATA_FORMAT "maxNotes" - not between 0 and EDAM_USER_NOTES_MAX </li> <li> BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed </li> <li> BAD_DATA_FORMAT "NoteFilter.tagGuids" - if any are malformed </li> <li> BAD_DATA_FORMAT "NoteFilter.words" - if search string too long </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Notebook.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Filter
- Offset
- MaxNotes
- ResultSpec
func (*NoteStoreClient) FindRelated ¶
func (p *NoteStoreClient) FindRelated(ctx context.Context, authenticationToken string, query *RelatedQuery, resultSpec *RelatedResultSpec) (r *RelatedResult, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Identify related entities on the service, such as notes, notebooks, and tags related to notes or content.
@param query
The information about which we are finding related entities.
@param resultSpec
Allows the client to indicate the type and quantity of information to be returned, allowing a saving of time and bandwidth.
@return
The result of the query, with information considered to likely be relevantly related to the information described by the query.
@throws EDAMUserException <ul>
<li>BAD_DATA_FORMAT "RelatedQuery.plainText" - If you provided a a zero-length plain text value. </li> <li>BAD_DATA_FORMAT "RelatedQuery.noteGuid" - If you provided an invalid Note GUID, that is, one that does not match the constraints defined by EDAM_GUID_LEN_MIN, EDAM_GUID_LEN_MAX, EDAM_GUID_REGEX. </li> <li> BAD_DATA_FORMAT "NoteFilter.notebookGuid" - if malformed </li> <li> BAD_DATA_FORMAT "NoteFilter.tagGuids" - if any are malformed </li> <li> BAD_DATA_FORMAT "NoteFilter.words" - if search string too long </li> <li>PERMISSION_DENIED "Note" - If the caller does not have access to the note identified by RelatedQuery.noteGuid. </li> <li>DATA_REQUIRED "RelatedResultSpec" - If you did not not set any values in the result spec. </li>
</ul>
@throws EDAMNotFoundException <ul>
<li>"RelatedQuery.noteGuid" - the note with that GUID is not found, if that field has been set in the query. </li>
</ul>
Parameters:
- AuthenticationToken
- Query
- ResultSpec
func (*NoteStoreClient) GetDefaultNotebook ¶
func (p *NoteStoreClient) GetDefaultNotebook(ctx context.Context, authenticationToken string) (r *Types.Notebook, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Returns the notebook that should be used to store new notes in the user's account when no other notebooks are specified.
Parameters:
- AuthenticationToken
func (*NoteStoreClient) GetFilteredSyncChunk ¶
func (p *NoteStoreClient) GetFilteredSyncChunk(ctx context.Context, authenticationToken string, afterUSN int32, maxEntries int32, filter *SyncChunkFilter) (r *SyncChunk, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Asks the NoteStore to provide the state of the account in order of last modification. This request retrieves one block of the server's state so that a client can make several small requests against a large account rather than getting the entire state in one big message. This call gives fine-grained control of the data that will be received by a client by omitting data elements that a client doesn't need. This may reduce network traffic and sync times.
@param afterUSN
The client can pass this value to ask only for objects that have been updated after a certain point. This allows the client to receive updates after its last checkpoint rather than doing a full synchronization on every pass. The default value of "0" indicates that the client wants to get objects from the start of the account.
@param maxEntries
The maximum number of modified objects that should be returned in the result SyncChunk. This can be used to limit the size of each individual message to be friendly for network transfer.
@param filter
The caller must set some of the flags in this structure to specify which data types should be returned during the synchronization. See the SyncChunkFilter structure for information on each flag.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "afterUSN" - if negative </li> <li> BAD_DATA_FORMAT "maxEntries" - if less than 1 </li>
</ul>
Parameters:
- AuthenticationToken
- AfterUSN
- MaxEntries
- Filter
func (*NoteStoreClient) GetLinkedNotebookSyncChunk ¶
func (p *NoteStoreClient) GetLinkedNotebookSyncChunk(ctx context.Context, authenticationToken string, linkedNotebook *Types.LinkedNotebook, afterUSN int32, maxEntries int32, fullSyncOnly bool) (r *SyncChunk, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Asks the NoteStore to provide information about the contents of a linked notebook that has been shared with the caller, or that is public to the world. This will return a result that is similar to getSyncChunk, but will only contain entries that are visible to the caller. I.e. only that particular Notebook will be visible, along with its Notes, and Tags on those Notes.
This function must be called on the shard that owns the referenced notebook. (I.e. the shardId in /shard/shardId/edam/note must be the same as LinkedNotebook.shardId.)
@param authenticationToken
This should be an authenticationToken for the guest who has received the invitation to the share. (I.e. this should not be the result of NoteStore.authenticateToSharedNotebook)
@param linkedNotebook
This structure should contain identifying information and permissions to access the notebook in question. This must contain the valid fields for either a shared notebook (e.g. shareKey) or a public notebook (e.g. username, uri)
@param afterUSN
The client can pass this value to ask only for objects that have been updated after a certain point. This allows the client to receive updates after its last checkpoint rather than doing a full synchronization on every pass. The default value of "0" indicates that the client wants to get objects from the start of the account.
@param maxEntries
The maximum number of modified objects that should be returned in the result SyncChunk. This can be used to limit the size of each individual message to be friendly for network transfer. Applications should not request more than 256 objects at a time, and must handle the case where the service returns less than the requested number of objects in a given request even though more objects are available on the service.
@param fullSyncOnly
If true, then the client only wants initial data for a full sync. In this case, the service will not return any expunged objects, and will not return any Resources, since these are also provided in their corresponding Notes.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "afterUSN" - if negative </li> <li> BAD_DATA_FORMAT "maxEntries" - if less than 1 </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "LinkedNotebook" - if the provided information doesn't match any valid notebook </li> <li> "LinkedNotebook.uri" - if the provided public URI doesn't match any valid notebook </li> <li> "SharedNotebook.id" - if the provided information indicates a shared notebook that no longer exists </li>
</ul>
Parameters:
- AuthenticationToken
- LinkedNotebook
- AfterUSN
- MaxEntries
- FullSyncOnly
func (*NoteStoreClient) GetLinkedNotebookSyncState ¶
func (p *NoteStoreClient) GetLinkedNotebookSyncState(ctx context.Context, authenticationToken string, linkedNotebook *Types.LinkedNotebook) (r *SyncState, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Asks the NoteStore to provide information about the status of a linked notebook that has been shared with the caller, or that is public to the world. This will return a result that is similar to getSyncState, but may omit SyncState.uploaded if the caller doesn't have permission to write to the linked notebook.
This function must be called on the shard that owns the referenced notebook. (I.e. the shardId in /shard/shardId/edam/note must be the same as LinkedNotebook.shardId.)
@param authenticationToken
This should be an authenticationToken for the guest who has received the invitation to the share. (I.e. this should not be the result of NoteStore.authenticateToSharedNotebook)
@param linkedNotebook
This structure should contain identifying information and permissions to access the notebook in question.
Parameters:
- AuthenticationToken
- LinkedNotebook
func (*NoteStoreClient) GetNote ¶
func (p *NoteStoreClient) GetNote(ctx context.Context, authenticationToken string, guid Types.Guid, withContent bool, withResourcesData bool, withResourcesRecognition bool, withResourcesAlternateData bool) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns the current state of the note in the service with the provided GUID. The ENML contents of the note will only be provided if the 'withContent' parameter is true. The service will include the meta-data for each resource in the note, but the binary contents of the resources and their recognition data will be omitted. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string). The applicationData fields are returned as keysOnly.
@param guid
The GUID of the note to be retrieved.
@param withContent
If true, the note will include the ENML contents of its 'content' field.
@param withResourcesData
If true, any Resource elements in this Note will include the binary contents of their 'data' field's body.
@param withResourcesRecognition
If true, any Resource elements will include the binary contents of the 'recognition' field's body if recognition data is present.
@param withResourcesAlternateData
If true, any Resource elements in this Note will include the binary contents of their 'alternateData' fields' body, if an alternate form is present.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Note" - private note, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
- WithContent
- WithResourcesData
- WithResourcesRecognition
- WithResourcesAlternateData
func (*NoteStoreClient) GetNoteApplicationData ¶
func (p *NoteStoreClient) GetNoteApplicationData(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.LazyMap, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Get all of the application data for the note identified by GUID, with values returned within the LazyMap fullMap field. If there are no applicationData entries, then a LazyMap with an empty fullMap will be returned. If your application only needs to fetch its own applicationData entry, use getNoteApplicationDataEntry instead.
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetNoteApplicationDataEntry ¶
func (p *NoteStoreClient) GetNoteApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Get the value of a single entry in the applicationData map for the note identified by GUID.
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - note not found, by GUID</li> <li> "NoteAttributes.applicationData.key" - note not found, by key</li>
</ul>
Parameters:
- AuthenticationToken
- Guid
- Key
func (*NoteStoreClient) GetNoteContent ¶
func (p *NoteStoreClient) GetNoteContent(ctx context.Context, authenticationToken string, guid Types.Guid) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns XHTML contents of the note with the provided GUID. If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
@param guid
The GUID of the note to be retrieved.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Note" - private note, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetNoteSearchText ¶
func (p *NoteStoreClient) GetNoteSearchText(ctx context.Context, authenticationToken string, guid Types.Guid, noteOnly bool, tokenizeForIndexing bool) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns a block of the extracted plain text contents of the note with the provided GUID. This text can be indexed for search purposes by a light client that doesn't have capabilities to extract all of the searchable text content from the note and its resources.
If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
@param guid
The GUID of the note to be retrieved.
@param noteOnly
If true, this will only return the text extracted from the ENML contents of the note itself. If false, this will also include the extracted text from any text-bearing resources (PDF, recognized images)
@param tokenizeForIndexing
If true, this will break the text into cleanly separated and sanitized tokens. If false, this will return the more raw text extraction, with its original punctuation, capitalization, spacing, etc.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Note" - private note, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
- NoteOnly
- TokenizeForIndexing
func (*NoteStoreClient) GetNoteTagNames ¶
func (p *NoteStoreClient) GetNoteTagNames(ctx context.Context, authenticationToken string, guid Types.Guid) (r []string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns a list of the names of the tags for the note with the provided guid. This can be used with authentication to get the tags for a user's own note, or can be used without valid authentication to retrieve the names of the tags for a note in a public notebook.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Note" - private note, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetNoteVersion ¶
func (p *NoteStoreClient) GetNoteVersion(ctx context.Context, authenticationToken string, noteGuid Types.Guid, updateSequenceNum int32, withResourcesData bool, withResourcesRecognition bool, withResourcesAlternateData bool) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
This can be used to retrieve a previous version of a Note after it has been updated within the service. The caller must identify the note (via its guid) and the version (via the updateSequenceNumber of that version). to find a listing of the stored version USNs for a note, call listNoteVersions. This call is only available for notes in Premium accounts. (I.e. access to past versions of Notes is a Premium-only feature.)
@param noteGuid
The GUID of the note to be retrieved.
@param updateSequenceNum
The USN of the version of the note that is being retrieved
@param withResourcesData
If true, any Resource elements in this Note will include the binary contents of their 'data' field's body.
@param withResourcesRecognition
If true, any Resource elements will include the binary contents of the 'recognition' field's body if recognition data is present.
@param withResourcesAlternateData
If true, any Resource elements in this Note will include the binary contents of their 'alternateData' fields' body, if an alternate form is present.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Note" - private note, user doesn't own </li> <li> PERMISSION_DENIED "updateSequenceNum" - The account isn't permitted to access previous versions of notes. (i.e. this is a Free account.) </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li> <li> "Note.updateSequenceNumber" - the Note doesn't have a version with the corresponding USN. </li>
</ul>
Parameters:
- AuthenticationToken
- NoteGuid
- UpdateSequenceNum
- WithResourcesData
- WithResourcesRecognition
- WithResourcesAlternateData
func (*NoteStoreClient) GetNotebook ¶
func (p *NoteStoreClient) GetNotebook(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.Notebook, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns the current state of the notebook with the provided GUID. The notebook may be active or deleted (but not expunged).
@param guid
The GUID of the notebook to be retrieved.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Notebook.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Notebook" - private notebook, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Notebook.guid" - tag not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetPublicNotebook ¶
func (p *NoteStoreClient) GetPublicNotebook(ctx context.Context, userId Types.UserID, publicUri string) (r *Types.Notebook, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
<p> Looks for a user account with the provided userId on this NoteStore shard and determines whether that account contains a public notebook with the given URI. If the account is not found, or no public notebook exists with this URI, this will throw an EDAMNotFoundException, otherwise this will return the information for that Notebook. </p> <p> If a notebook is visible on the web with a full URL like http://www.evernote.com/pub/sethdemo/api Then 'sethdemo' is the username that can be used to look up the userId, and 'api' is the publicUri. </p>
@param userId
The numeric identifier for the user who owns the public notebook. To find this value based on a username string, you can invoke UserStore.getPublicUserInfo
@param publicUri
The uri string for the public notebook, from Notebook.publishing.uri.
@throws EDAMNotFoundException <ul>
<li>"Publishing.uri" - not found, by URI</li>
</ul>
@throws EDAMSystemException <ul>
<li> TAKEN_DOWN "PublicNotebook" - The specified public notebook is taken down (for all requesters).</li> <li> TAKEN_DOWN "Country" - The specified public notebook is taken down for the requester because of an IP-based country lookup.</li>
</ul>
Parameters:
- UserId
- PublicUri
func (*NoteStoreClient) GetResource ¶
func (p *NoteStoreClient) GetResource(ctx context.Context, authenticationToken string, guid Types.Guid, withData bool, withRecognition bool, withAttributes bool, withAlternateData bool) (r *Types.Resource, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns the current state of the resource in the service with the provided GUID. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string). Only the keys for the applicationData will be returned.
@param guid
The GUID of the resource to be retrieved.
@param withData
If true, the Resource will include the binary contents of the 'data' field's body.
@param withRecognition
If true, the Resource will include the binary contents of the 'recognition' field's body if recognition data is present.
@param withAttributes
If true, the Resource will include the attributes
@param withAlternateData
If true, the Resource will include the binary contents of the 'alternateData' field's body, if an alternate form is present.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Resource.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
- WithData
- WithRecognition
- WithAttributes
- WithAlternateData
func (*NoteStoreClient) GetResourceAlternateData ¶
func (p *NoteStoreClient) GetResourceAlternateData(ctx context.Context, authenticationToken string, guid Types.Guid) (r []byte, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
If the Resource with the provided GUID has an alternate data representation (indicated via the Resource.alternateData field), then this request can be used to retrieve the binary contents of that alternate data file. If the caller asks about a resource that has no alternate data form, this will throw EDAMNotFoundException.
@param guid
The GUID of the resource whose recognition data should be retrieved.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Resource.guid" - not found, by GUID </li> <li> "Resource.alternateData" - resource has no recognition </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetResourceApplicationData ¶
func (p *NoteStoreClient) GetResourceApplicationData(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.LazyMap, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Get all of the application data for the Resource identified by GUID, with values returned within the LazyMap fullMap field. If there are no applicationData entries, then a LazyMap with an empty fullMap will be returned. If your application only needs to fetch its own applicationData entry, use getResourceApplicationDataEntry instead.
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetResourceApplicationDataEntry ¶
func (p *NoteStoreClient) GetResourceApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Get the value of a single entry in the applicationData map for the Resource identified by GUID.
@throws EDAMNotFoundException <ul>
<li> "Resource.guid" - Resource not found, by GUID</li> <li> "ResourceAttributes.applicationData.key" - Resource not found, by key</li>
</ul>
Parameters:
- AuthenticationToken
- Guid
- Key
func (*NoteStoreClient) GetResourceAttributes ¶
func (p *NoteStoreClient) GetResourceAttributes(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.ResourceAttributes, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns the set of attributes for the Resource with the provided GUID. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
@param guid
The GUID of the resource whose attributes should be retrieved.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Resource.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetResourceByHash ¶
func (p *NoteStoreClient) GetResourceByHash(ctx context.Context, authenticationToken string, noteGuid Types.Guid, contentHash []byte, withData bool, withRecognition bool, withAlternateData bool) (r *Types.Resource, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns the current state of a resource, referenced by containing note GUID and resource content hash.
@param noteGuid
The GUID of the note that holds the resource to be retrieved.
@param contentHash
The MD5 checksum of the resource within that note. Note that this is the binary checksum, for example from Resource.data.bodyHash, and not the hex-encoded checksum that is used within an en-media tag in a note body.
@param withData
If true, the Resource will include the binary contents of the 'data' field's body.
@param withRecognition
If true, the Resource will include the binary contents of the 'recognition' field's body.
@param withAlternateData
If true, the Resource will include the binary contents of the 'alternateData' field's body, if an alternate form is present.
@throws EDAMUserException <ul>
<li> DATA_REQUIRED "Note.guid" - noteGuid param missing </li> <li> DATA_REQUIRED "Note.contentHash" - contentHash param missing </li> <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note" - not found, by guid </li> <li> "Resource" - not found, by hash </li>
</ul>
Parameters:
- AuthenticationToken
- NoteGuid
- ContentHash
- WithData
- WithRecognition
- WithAlternateData
func (*NoteStoreClient) GetResourceData ¶
func (p *NoteStoreClient) GetResourceData(ctx context.Context, authenticationToken string, guid Types.Guid) (r []byte, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns binary data of the resource with the provided GUID. For example, if this were an image resource, this would contain the raw bits of the image. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
@param guid
The GUID of the resource to be retrieved.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Resource.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetResourceRecognition ¶
func (p *NoteStoreClient) GetResourceRecognition(ctx context.Context, authenticationToken string, guid Types.Guid) (r []byte, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns the binary contents of the recognition index for the resource with the provided GUID. If the caller asks about a resource that has no recognition data, this will throw EDAMNotFoundException. If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
@param guid
The GUID of the resource whose recognition data should be retrieved.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Resource.guid" - not found, by GUID </li> <li> "Resource.recognition" - resource has no recognition </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetResourceSearchText ¶
func (p *NoteStoreClient) GetResourceSearchText(ctx context.Context, authenticationToken string, guid Types.Guid) (r string, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns a block of the extracted plain text contents of the resource with the provided GUID. This text can be indexed for search purposes by a light client that doesn't have capability to extract all of the searchable text content from a resource.
If the Resource is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
@param guid
The GUID of the resource to be retrieved.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Resource.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetSearch ¶
func (p *NoteStoreClient) GetSearch(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.SavedSearch, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns the current state of the search with the provided GUID.
@param guid
The GUID of the search to be retrieved.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "SavedSearch.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "SavedSearch" - private Tag, user doesn't own </li>
@throws EDAMNotFoundException <ul>
<li> "SavedSearch.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) GetSharedNotebookByAuth ¶
func (p *NoteStoreClient) GetSharedNotebookByAuth(ctx context.Context, authenticationToken string) (r *Types.SharedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
This function is used to retrieve extended information about a shared notebook by a guest who has already authenticated to access that notebook. This requires an 'authenticationToken' parameter which should be the resut of a call to authenticateToSharedNotebook(...). I.e. this is the token that gives access to the particular shared notebook in someone else's account -- it's not the authenticationToken for the owner of the notebook itself.
@param authenticationToken
Should be the authentication token retrieved from the reply of authenticateToSharedNotebook(ctx), proving access to a particular shared notebook.
@throws EDAMUserException <ul>
<li> PERMISSION_DENIED "authenticationToken" - authentication token doesn't correspond to a valid shared notebook </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "SharedNotebook.id" - the shared notebook no longer exists </li>
</ul>
Parameters:
- AuthenticationToken
func (*NoteStoreClient) GetSyncChunk ¶
func (p *NoteStoreClient) GetSyncChunk(ctx context.Context, authenticationToken string, afterUSN int32, maxEntries int32, fullSyncOnly bool) (r *SyncChunk, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
DEPRECATED - use getFilteredSyncChunk.
Parameters:
- AuthenticationToken
- AfterUSN
- MaxEntries
- FullSyncOnly
func (*NoteStoreClient) GetSyncState ¶
func (p *NoteStoreClient) GetSyncState(ctx context.Context, authenticationToken string) (r *SyncState, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Asks the NoteStore to provide information about the status of the user account corresponding to the provided authentication token.
Parameters:
- AuthenticationToken
func (*NoteStoreClient) GetSyncStateWithMetrics ¶
func (p *NoteStoreClient) GetSyncStateWithMetrics(ctx context.Context, authenticationToken string, clientMetrics *ClientUsageMetrics) (r *SyncState, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Asks the NoteStore to provide information about the status of the user account corresponding to the provided authentication token. This version of 'getSyncState' allows the client to upload coarse- grained usage metrics to the service.
@param clientMetrics see the documentation of the ClientUsageMetrics
structure for an explanation of the fields that clients can pass to the service.
Parameters:
- AuthenticationToken
- ClientMetrics
func (*NoteStoreClient) GetTag ¶
func (p *NoteStoreClient) GetTag(ctx context.Context, authenticationToken string, guid Types.Guid) (r *Types.Tag, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns the current state of the Tag with the provided GUID.
@param guid
The GUID of the tag to be retrieved.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Tag.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Tag" - private Tag, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Tag.guid" - tag not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) ListLinkedNotebooks ¶
func (p *NoteStoreClient) ListLinkedNotebooks(ctx context.Context, authenticationToken string) (r []*Types.LinkedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Returns a list of linked notebooks
Parameters:
- AuthenticationToken
func (*NoteStoreClient) ListNoteVersions ¶
func (p *NoteStoreClient) ListNoteVersions(ctx context.Context, authenticationToken string, noteGuid Types.Guid) (r []*NoteVersionId, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns a list of the prior versions of a particular note that are saved within the service. These prior versions are stored to provide a recovery from unintentional removal of content from a note. The identifiers that are returned by this call can be used with getNoteVersion to retrieve the previous note. The identifiers will be listed from the most recent versions to the oldest.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Note" - private note, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- NoteGuid
func (*NoteStoreClient) ListNotebooks ¶
func (p *NoteStoreClient) ListNotebooks(ctx context.Context, authenticationToken string) (r []*Types.Notebook, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Returns a list of all of the notebooks in the account.
Parameters:
- AuthenticationToken
func (*NoteStoreClient) ListSearches ¶
func (p *NoteStoreClient) ListSearches(ctx context.Context, authenticationToken string) (r []*Types.SavedSearch, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Returns a list of the searches in the account. Evernote does not support the undeletion of searches, so this will only include active searches.
Parameters:
- AuthenticationToken
func (*NoteStoreClient) ListSharedNotebooks ¶
func (p *NoteStoreClient) ListSharedNotebooks(ctx context.Context, authenticationToken string) (r []*Types.SharedNotebook, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Lists the collection of shared notebooks for all notebooks in the users account.
@return
The list of all SharedNotebooks for the user
Parameters:
- AuthenticationToken
func (*NoteStoreClient) ListTags ¶
func (p *NoteStoreClient) ListTags(ctx context.Context, authenticationToken string) (r []*Types.Tag, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, err error)
Returns a list of the tags in the account. Evernote does not support the undeletion of tags, so this will only include active tags.
Parameters:
- AuthenticationToken
func (*NoteStoreClient) ListTagsByNotebook ¶
func (p *NoteStoreClient) ListTagsByNotebook(ctx context.Context, authenticationToken string, notebookGuid Types.Guid) (r []*Types.Tag, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Returns a list of the tags that are applied to at least one note within the provided notebook. If the notebook is public, the authenticationToken may be ignored.
@param notebookGuid
the GUID of the notebook to use to find tags
@throws EDAMNotFoundException <ul>
<li> "Notebook.guid" - notebook not found by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- NotebookGuid
func (*NoteStoreClient) SendMessageToSharedNotebookMembers ¶
func (p *NoteStoreClient) SendMessageToSharedNotebookMembers(ctx context.Context, authenticationToken string, notebookGuid Types.Guid, messageText string, recipients []string) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Send a reminder message to some or all of the email addresses that a notebook has been shared with. The message includes the current link to view the notebook. @param authenticationToken
The auth token of the user with permissions to share the notebook
@param notebookGuid
The guid of the shared notebook
@param messageText
User provided text to include in the email
@param recipients
The email addresses of the recipients. If this list is empty then all of the users that the notebook has been shared with are emailed. If an email address doesn't correspond to share invite members then that address is ignored.
@return
The number of messages sent
@throws EDAMUserException <ul>
<li> LIMIT_REACHED "(recipients)" - The email can't be sent because this would exceed the user's daily email limit. </li> <li> PERMISSION_DENIED "Notebook.guid" - The user doesn't have permission to send a message for the specified notebook. </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Notebook.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- NotebookGuid
- MessageText
- Recipients
func (*NoteStoreClient) SetNoteApplicationDataEntry ¶
func (p *NoteStoreClient) SetNoteApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string, value string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Update, or create, an entry in the applicationData map for the note identified by guid.
Parameters:
- AuthenticationToken
- Guid
- Key
- Value
func (*NoteStoreClient) SetResourceApplicationDataEntry ¶
func (p *NoteStoreClient) SetResourceApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string, value string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Update, or create, an entry in the applicationData map for the Resource identified by guid.
Parameters:
- AuthenticationToken
- Guid
- Key
- Value
func (*NoteStoreClient) SetSharedNotebookRecipientSettings ¶
func (p *NoteStoreClient) SetSharedNotebookRecipientSettings(ctx context.Context, authenticationToken string, sharedNotebookId int64, recipientSettings *Types.SharedNotebookRecipientSettings) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Set values for the recipient settings associated with a shared notebook. Having update rights to the shared notebook record itself has no effect on this call; only the recipient of the shared notebook can can the recipient settings.
If you do <i>not</i> wish to, or cannot, change one of the reminderNotifyEmail or reminderNotifyInApp fields, you must leave that field unset in recipientSettings. This method will skip that field for updates and leave the existing state as it is.
@return The update sequence number of the account to which the shared notebook
belongs, which is the account from which we are sharing a notebook.
@throws EDAMNotFoundException "sharedNotebookId" - Thrown if the service does not
have a shared notebook record for the sharedNotebookId on the given shard. If you receive this exception, it is probable that the shared notebook record has been revoked or expired, or that you accessed the wrong shard.
@throws EDAMUserException <ul>
<li>PEMISSION_DENIED "authenticationToken" - If you do not have permission to set the recipient settings for the shared notebook. Only the recipient has permission to do this. <li>DATA_CONFLICT "recipientSettings.reminderNotifyEmail" - Setting whether or not you want to receive reminder e-mail notifications is possible on a business notebook in the business to which the user belongs. All others can safely unset the reminderNotifyEmail field from the recipientSettings parameter.
</ul>
Parameters:
- AuthenticationToken
- SharedNotebookId
- RecipientSettings
func (*NoteStoreClient) ShareNote ¶
func (p *NoteStoreClient) ShareNote(ctx context.Context, authenticationToken string, guid Types.Guid) (r string, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
If this note is not already shared (via its own direct URL), then this will start sharing that note. This will return the secret "Note Key" for this note that can currently be used in conjunction with the Note's GUID to gain direct read-only access to the Note. If the note is already shared, then this won't make any changes to the note, and the existing "Note Key" will be returned. The only way to change the Note Key for an existing note is to stopSharingNote first, and then call this function.
@param guid
The GUID of the note to be shared.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Note" - private note, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) StopSharingNote ¶
func (p *NoteStoreClient) StopSharingNote(ctx context.Context, authenticationToken string, guid Types.Guid) (userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
If this note is not already shared then this will stop sharing that note and invalidate its "Note Key", so any existing URLs to access that Note will stop working. If the Note is not shared, then this function will do nothing.
@param guid
The GUID of the note to be un-shared.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.guid" - if the parameter is missing </li> <li> PERMISSION_DENIED "Note" - private note, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) UnsetNoteApplicationDataEntry ¶
func (p *NoteStoreClient) UnsetNoteApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Remove an entry identified by 'key' from the applicationData map for the note identified by 'guid'. Silently ignores an unset of a non-existing key.
Parameters:
- AuthenticationToken
- Guid
- Key
func (*NoteStoreClient) UnsetResourceApplicationDataEntry ¶
func (p *NoteStoreClient) UnsetResourceApplicationDataEntry(ctx context.Context, authenticationToken string, guid Types.Guid, key string) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Remove an entry identified by 'key' from the applicationData map for the Resource identified by 'guid'.
Parameters:
- AuthenticationToken
- Guid
- Key
func (*NoteStoreClient) UntagAll ¶
func (p *NoteStoreClient) UntagAll(ctx context.Context, authenticationToken string, guid Types.Guid) (userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Removes the provided tag from every note that is currently tagged with this tag. If this operation is successful, the tag will still be in the account, but it will not be tagged on any notes.
This function is not indended for use by full synchronizing clients, since it does not provide enough result information to the client to reconcile the local state without performing a follow-up sync from the service. This is intended for "thin clients" that need to efficiently support this as a UI operation.
@param guid
The GUID of the tag to remove from all notes.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Tag.guid" - if the guid parameter is missing </li> <li> PERMISSION_DENIED "Tag" - user doesn't own tag </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Tag.guid" - tag not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Guid
func (*NoteStoreClient) UpdateLinkedNotebook ¶
func (p *NoteStoreClient) UpdateLinkedNotebook(ctx context.Context, authenticationToken string, linkedNotebook *Types.LinkedNotebook) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
@param linkedNotebook
Updates the name of a linked notebook.
@return
The Update Sequence Number for this change within the account.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "LinkedNotebook.name" - invalid length or pattern </li>
</ul>
Parameters:
- AuthenticationToken
- LinkedNotebook
func (*NoteStoreClient) UpdateNote ¶
func (p *NoteStoreClient) UpdateNote(ctx context.Context, authenticationToken string, note *Types.Note) (r *Types.Note, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Submit a set of changes to a note to the service. The provided data must include the note's guid field for identification. The note's title must also be set.
@param note
A Note object containing the desired fields to be populated on the service. With the exception of the note's title and guid, fields that are not being changed do not need to be set. If the content is not being modified, note.content should be left unset. If the list of resources is not being modified, note.resources should be left unset.
@return
The metadata (no contents) for the Note on the server after the update
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Note.title" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "Note.content" - invalid length for ENML body </li> <li> BAD_DATA_FORMAT "NoteAttributes.*" - bad resource string </li> <li> BAD_DATA_FORMAT "ResourceAttributes.*" - bad resource string </li> <li> BAD_DATA_FORMAT "Resource.mime" - invalid resource MIME type </li> <li> DATA_CONFLICT "Note.deleted" - deleted time set on active note </li> <li> DATA_REQUIRED "Resource.data" - resource data body missing </li> <li> ENML_VALIDATION "*" - note content doesn't validate against DTD </li> <li> LIMIT_REACHED "Note.tagGuids" - too many Tags on Note </li> <li> LIMIT_REACHED "Note.resources" - too many resources on Note </li> <li> LIMIT_REACHED "Note.size" - total note size too large </li> <li> LIMIT_REACHED "Resource.data.size" - resource too large </li> <li> LIMIT_REACHED "NoteAttribute.*" - attribute string too long </li> <li> LIMIT_REACHED "ResourceAttribute.*" - attribute string too long </li> <li> PERMISSION_DENIED "Note" - user doesn't own </li> <li> PERMISSION_DENIED "Note.notebookGuid" - user doesn't own destination </li> <li> QUOTA_REACHED "Accounting.uploadLimit" - note exceeds upload quota </li> <li> BAD_DATA_FORMAT "Tag.name" - Note.tagNames was provided, and one of the specified tags had an invalid length or pattern </li> <li> LIMIT_REACHED "Tag" - Note.tagNames was provided, and the required new tags would exceed the maximum number per account </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Note.guid" - note not found, by GUID </li> <li> "Note.notebookGuid" - if notebookGuid provided, but not found </li>
</ul>
Parameters:
- AuthenticationToken
- Note
func (*NoteStoreClient) UpdateNotebook ¶
func (p *NoteStoreClient) UpdateNotebook(ctx context.Context, authenticationToken string, notebook *Types.Notebook) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Submits notebook changes to the service. The provided data must include the notebook's guid field for identification.
@param notebook
The notebook object containing the requested changes.
@return
The Update Sequence Number for this change within the account.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Notebook.name" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "Notebook.stack" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "Publishing.uri" - if publishing set but bad uri </li> <li> BAD_DATA_FORMAT "Publishing.publicDescription" - if too long </li> <li> DATA_CONFLICT "Notebook.name" - name already in use </li> <li> DATA_CONFLICT "Publishing.uri" - if URI already in use </li> <li> DATA_REQUIRED "Publishing.uri" - if publishing set but uri missing </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Notebook.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Notebook
func (*NoteStoreClient) UpdateResource ¶
func (p *NoteStoreClient) UpdateResource(ctx context.Context, authenticationToken string, resource *Types.Resource) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Submit a set of changes to a resource to the service. This can be used to update the meta-data about the resource, but cannot be used to change the binary contents of the resource (including the length and hash). These cannot be changed directly without creating a new resource and removing the old one via updateNote.
@param resource
A Resource object containing the desired fields to be populated on the service. The service will attempt to update the resource with the following fields from the client: <ul> <li>guid: must be provided to identify the resource </li> <li>mime </li> <li>width </li> <li>height </li> <li>duration </li> <li>attributes: optional. if present, the set of attributes will be replaced. </li> </ul>
@return
The Update Sequence Number of the resource after the changes have been applied.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Resource.guid" - if the parameter is missing </li> <li> BAD_DATA_FORMAT "Resource.mime" - invalid resource MIME type </li> <li> BAD_DATA_FORMAT "ResourceAttributes.*" - bad resource string </li> <li> LIMIT_REACHED "ResourceAttribute.*" - attribute string too long </li> <li> PERMISSION_DENIED "Resource" - private resource, user doesn't own </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Resource.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Resource
func (*NoteStoreClient) UpdateSearch ¶
func (p *NoteStoreClient) UpdateSearch(ctx context.Context, authenticationToken string, search *Types.SavedSearch) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Submits search changes to the service. The provided data must include the search's guid field for identification. The service will apply updates to the following search fields: name, query, and scope.
@param search
The search object containing the requested changes.
@return
The Update Sequence Number for this change within the account.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "SavedSearch.name" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "SavedSearch.query" - invalid length </li> <li> DATA_CONFLICT "SavedSearch.name" - name already in use </li> <li> PERMISSION_DENIED "SavedSearch" - user doesn't own tag </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "SavedSearch.guid" - not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Search
func (*NoteStoreClient) UpdateSharedNotebook ¶
func (p *NoteStoreClient) UpdateSharedNotebook(ctx context.Context, authenticationToken string, sharedNotebook *Types.SharedNotebook) (r int32, userException *Errors.EDAMUserException, notFoundException *Errors.EDAMNotFoundException, systemException *Errors.EDAMSystemException, err error)
Update a SharedNotebook object.
@param authenticationToken
Must be an authentication token from the owner or a shared notebook authentication token or business authentication token with sufficient permissions to change invitations for a notebook.
@param sharedNotebook
The SharedNotebook object containing the requested changes. The "id" of the shared notebook must be set to allow the service to identify the SharedNotebook to be updated. In addition, you MUST set the email, permission, and allowPreview fields to the desired values. All other fields will be ignored if set.
@return
The Update Serial Number for this change within the account.
@throws EDAMUserException <ul>
<li>UNSUPPORTED_OPERATION "updateSharedNotebook" - if this service instance does not support shared notebooks.</li> <li>BAD_DATA_FORMAT "SharedNotebook.email" - if the email was not valid.</li> <li>DATA_REQUIRED "SharedNotebook.id" - if the id field was not set.</li> <li>DATA_REQUIRED "SharedNotebook.privilege" - if the privilege field was not set.</li> <li>DATA_REQUIRED "SharedNotebook.allowPreview" - if the allowPreview field was not set.</li> </ul>
@throws EDAMNotFoundException <ul>
<li>SharedNotebook.id - if no shared notebook with the specified ID was found. </ul>
Parameters:
- AuthenticationToken
- SharedNotebook
func (*NoteStoreClient) UpdateTag ¶
func (p *NoteStoreClient) UpdateTag(ctx context.Context, authenticationToken string, tag *Types.Tag) (r int32, userException *Errors.EDAMUserException, systemException *Errors.EDAMSystemException, notFoundException *Errors.EDAMNotFoundException, err error)
Submits tag changes to the service. The provided data must include the tag's guid field for identification. The service will apply updates to the following tag fields: name, parentGuid
@param tag
The tag object containing the requested changes.
@return
The Update Sequence Number for this change within the account.
@throws EDAMUserException <ul>
<li> BAD_DATA_FORMAT "Tag.name" - invalid length or pattern </li> <li> BAD_DATA_FORMAT "Tag.parentGuid" - malformed GUID </li> <li> DATA_CONFLICT "Tag.name" - name already in use </li> <li> DATA_CONFLICT "Tag.parentGuid" - can't set parent: circular </li> <li> PERMISSION_DENIED "Tag" - user doesn't own tag </li>
</ul>
@throws EDAMNotFoundException <ul>
<li> "Tag.guid" - tag not found, by GUID </li> <li> "Tag.parentGuid" - parent not found, by GUID </li>
</ul>
Parameters:
- AuthenticationToken
- Tag
type NoteStoreProcessor ¶
type NoteStoreProcessor struct {
// contains filtered or unexported fields
}
func NewNoteStoreProcessor ¶
func NewNoteStoreProcessor(handler NoteStore) *NoteStoreProcessor
func (*NoteStoreProcessor) AddToProcessorMap ¶
func (p *NoteStoreProcessor) AddToProcessorMap(key string, processor thrift.TProcessorFunction)
func (*NoteStoreProcessor) GetProcessorFunction ¶
func (p *NoteStoreProcessor) GetProcessorFunction(key string) (processor thrift.TProcessorFunction, ok bool)
func (*NoteStoreProcessor) Process ¶
func (p *NoteStoreProcessor) Process(ctx context.Context, iprot, oprot thrift.TProtocol) (success bool, exp thrift.TException)
func (*NoteStoreProcessor) ProcessorMap ¶
func (p *NoteStoreProcessor) ProcessorMap() map[string]thrift.TProcessorFunction
type NoteVersionId ¶
type NoteVersionId struct { UpdateSequenceNum int32 `thrift:"updateSequenceNum,1,required"` Updated Types.Timestamp `thrift:"updated,2,required"` Saved Types.Timestamp `thrift:"saved,3,required"` Title string `thrift:"title,4,required"` }
func NewNoteVersionId ¶
func NewNoteVersionId() *NoteVersionId
func (*NoteVersionId) String ¶
func (p *NoteVersionId) String() string
type NotesMetadataList ¶
type NotesMetadataList struct { StartIndex int32 `thrift:"startIndex,1,required"` TotalNotes int32 `thrift:"totalNotes,2,required"` Notes []*NoteMetadata `thrift:"notes,3,required"` StoppedWords []string `thrift:"stoppedWords,4"` SearchedWords []string `thrift:"searchedWords,5"` UpdateCount int32 `thrift:"updateCount,6"` }
func NewNotesMetadataList ¶
func NewNotesMetadataList() *NotesMetadataList
func (*NotesMetadataList) IsSetSearchedWords ¶
func (p *NotesMetadataList) IsSetSearchedWords() bool
func (*NotesMetadataList) IsSetStoppedWords ¶
func (p *NotesMetadataList) IsSetStoppedWords() bool
func (*NotesMetadataList) IsSetUpdateCount ¶
func (p *NotesMetadataList) IsSetUpdateCount() bool
func (*NotesMetadataList) String ¶
func (p *NotesMetadataList) String() string
type NotesMetadataResultSpec ¶
type NotesMetadataResultSpec struct { // unused field # 1 IncludeTitle bool `thrift:"includeTitle,2"` // unused field # 3 // unused field # 4 IncludeContentLength bool `thrift:"includeContentLength,5"` IncludeCreated bool `thrift:"includeCreated,6"` IncludeUpdated bool `thrift:"includeUpdated,7"` IncludeDeleted bool `thrift:"includeDeleted,8"` // unused field # 9 IncludeUpdateSequenceNum bool `thrift:"includeUpdateSequenceNum,10"` IncludeNotebookGuid bool `thrift:"includeNotebookGuid,11"` IncludeTagGuids bool `thrift:"includeTagGuids,12"` // unused field # 13 IncludeAttributes bool `thrift:"includeAttributes,14"` // unused field # 15 // unused field # 16 // unused field # 17 // unused field # 18 // unused field # 19 IncludeLargestResourceMime bool `thrift:"includeLargestResourceMime,20"` IncludeLargestResourceSize bool `thrift:"includeLargestResourceSize,21"` }
func NewNotesMetadataResultSpec ¶
func NewNotesMetadataResultSpec() *NotesMetadataResultSpec
func (*NotesMetadataResultSpec) IsSetIncludeAttributes ¶
func (p *NotesMetadataResultSpec) IsSetIncludeAttributes() bool
func (*NotesMetadataResultSpec) IsSetIncludeContentLength ¶
func (p *NotesMetadataResultSpec) IsSetIncludeContentLength() bool
func (*NotesMetadataResultSpec) IsSetIncludeCreated ¶
func (p *NotesMetadataResultSpec) IsSetIncludeCreated() bool
func (*NotesMetadataResultSpec) IsSetIncludeDeleted ¶
func (p *NotesMetadataResultSpec) IsSetIncludeDeleted() bool
func (*NotesMetadataResultSpec) IsSetIncludeLargestResourceMime ¶
func (p *NotesMetadataResultSpec) IsSetIncludeLargestResourceMime() bool
func (*NotesMetadataResultSpec) IsSetIncludeLargestResourceSize ¶
func (p *NotesMetadataResultSpec) IsSetIncludeLargestResourceSize() bool
func (*NotesMetadataResultSpec) IsSetIncludeNotebookGuid ¶
func (p *NotesMetadataResultSpec) IsSetIncludeNotebookGuid() bool
func (*NotesMetadataResultSpec) IsSetIncludeTagGuids ¶
func (p *NotesMetadataResultSpec) IsSetIncludeTagGuids() bool
func (*NotesMetadataResultSpec) IsSetIncludeTitle ¶
func (p *NotesMetadataResultSpec) IsSetIncludeTitle() bool
func (*NotesMetadataResultSpec) IsSetIncludeUpdateSequenceNum ¶
func (p *NotesMetadataResultSpec) IsSetIncludeUpdateSequenceNum() bool
func (*NotesMetadataResultSpec) IsSetIncludeUpdated ¶
func (p *NotesMetadataResultSpec) IsSetIncludeUpdated() bool
func (*NotesMetadataResultSpec) String ¶
func (p *NotesMetadataResultSpec) String() string
type RelatedQuery ¶
type RelatedQuery struct { NoteGuid string `thrift:"noteGuid,1"` PlainText string `thrift:"plainText,2"` Filter *NoteFilter `thrift:"filter,3"` ReferenceUri string `thrift:"referenceUri,4"` }
func NewRelatedQuery ¶
func NewRelatedQuery() *RelatedQuery
func (*RelatedQuery) IsSetFilter ¶
func (p *RelatedQuery) IsSetFilter() bool
func (*RelatedQuery) IsSetNoteGuid ¶
func (p *RelatedQuery) IsSetNoteGuid() bool
func (*RelatedQuery) IsSetPlainText ¶
func (p *RelatedQuery) IsSetPlainText() bool
func (*RelatedQuery) IsSetReferenceUri ¶
func (p *RelatedQuery) IsSetReferenceUri() bool
func (*RelatedQuery) String ¶
func (p *RelatedQuery) String() string
type RelatedResult ¶
type RelatedResult struct { Notes []*Types.Note `thrift:"notes,1"` Notebooks []*Types.Notebook `thrift:"notebooks,2"` Tags []*Types.Tag `thrift:"tags,3"` ContainingNotebooks []*Types.NotebookDescriptor `thrift:"containingNotebooks,4"` }
func NewRelatedResult ¶
func NewRelatedResult() *RelatedResult
func (*RelatedResult) IsSetContainingNotebooks ¶
func (p *RelatedResult) IsSetContainingNotebooks() bool
func (*RelatedResult) IsSetNotebooks ¶
func (p *RelatedResult) IsSetNotebooks() bool
func (*RelatedResult) IsSetNotes ¶
func (p *RelatedResult) IsSetNotes() bool
func (*RelatedResult) IsSetTags ¶
func (p *RelatedResult) IsSetTags() bool
func (*RelatedResult) String ¶
func (p *RelatedResult) String() string
type RelatedResultSpec ¶
type RelatedResultSpec struct { MaxNotes int32 `thrift:"maxNotes,1"` MaxNotebooks int32 `thrift:"maxNotebooks,2"` MaxTags int32 `thrift:"maxTags,3"` WritableNotebooksOnly bool `thrift:"writableNotebooksOnly,4"` IncludeContainingNotebooks bool `thrift:"includeContainingNotebooks,5"` }
func NewRelatedResultSpec ¶
func NewRelatedResultSpec() *RelatedResultSpec
func (*RelatedResultSpec) IsSetIncludeContainingNotebooks ¶
func (p *RelatedResultSpec) IsSetIncludeContainingNotebooks() bool
func (*RelatedResultSpec) IsSetMaxNotebooks ¶
func (p *RelatedResultSpec) IsSetMaxNotebooks() bool
func (*RelatedResultSpec) IsSetMaxNotes ¶
func (p *RelatedResultSpec) IsSetMaxNotes() bool
func (*RelatedResultSpec) IsSetMaxTags ¶
func (p *RelatedResultSpec) IsSetMaxTags() bool
func (*RelatedResultSpec) IsSetWritableNotebooksOnly ¶
func (p *RelatedResultSpec) IsSetWritableNotebooksOnly() bool
func (*RelatedResultSpec) String ¶
func (p *RelatedResultSpec) String() string
type SendMessageToSharedNotebookMembersArgs ¶
type SendMessageToSharedNotebookMembersArgs struct {}
func NewSendMessageToSharedNotebookMembersArgs ¶
func NewSendMessageToSharedNotebookMembersArgs() *SendMessageToSharedNotebookMembersArgs
func (*SendMessageToSharedNotebookMembersArgs) String ¶
func (p *SendMessageToSharedNotebookMembersArgs) String() string
type SendMessageToSharedNotebookMembersResult ¶
type SendMessageToSharedNotebookMembersResult struct {}
func NewSendMessageToSharedNotebookMembersResult ¶
func NewSendMessageToSharedNotebookMembersResult() *SendMessageToSharedNotebookMembersResult
func (*SendMessageToSharedNotebookMembersResult) String ¶
func (p *SendMessageToSharedNotebookMembersResult) String() string
type SetNoteApplicationDataEntryArgs ¶
type SetNoteApplicationDataEntryArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` Key string `thrift:"key,3"` Value string `thrift:"value,4"` }
func NewSetNoteApplicationDataEntryArgs ¶
func NewSetNoteApplicationDataEntryArgs() *SetNoteApplicationDataEntryArgs
func (*SetNoteApplicationDataEntryArgs) String ¶
func (p *SetNoteApplicationDataEntryArgs) String() string
type SetNoteApplicationDataEntryResult ¶
type SetNoteApplicationDataEntryResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewSetNoteApplicationDataEntryResult ¶
func NewSetNoteApplicationDataEntryResult() *SetNoteApplicationDataEntryResult
func (*SetNoteApplicationDataEntryResult) String ¶
func (p *SetNoteApplicationDataEntryResult) String() string
type SetResourceApplicationDataEntryArgs ¶
type SetResourceApplicationDataEntryArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` Key string `thrift:"key,3"` Value string `thrift:"value,4"` }
func NewSetResourceApplicationDataEntryArgs ¶
func NewSetResourceApplicationDataEntryArgs() *SetResourceApplicationDataEntryArgs
func (*SetResourceApplicationDataEntryArgs) String ¶
func (p *SetResourceApplicationDataEntryArgs) String() string
type SetResourceApplicationDataEntryResult ¶
type SetResourceApplicationDataEntryResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewSetResourceApplicationDataEntryResult ¶
func NewSetResourceApplicationDataEntryResult() *SetResourceApplicationDataEntryResult
func (*SetResourceApplicationDataEntryResult) String ¶
func (p *SetResourceApplicationDataEntryResult) String() string
type SetSharedNotebookRecipientSettingsArgs ¶
type SetSharedNotebookRecipientSettingsArgs struct {}
func NewSetSharedNotebookRecipientSettingsArgs ¶
func NewSetSharedNotebookRecipientSettingsArgs() *SetSharedNotebookRecipientSettingsArgs
func (*SetSharedNotebookRecipientSettingsArgs) String ¶
func (p *SetSharedNotebookRecipientSettingsArgs) String() string
type SetSharedNotebookRecipientSettingsResult ¶
type SetSharedNotebookRecipientSettingsResult struct {}
func NewSetSharedNotebookRecipientSettingsResult ¶
func NewSetSharedNotebookRecipientSettingsResult() *SetSharedNotebookRecipientSettingsResult
func (*SetSharedNotebookRecipientSettingsResult) String ¶
func (p *SetSharedNotebookRecipientSettingsResult) String() string
type ShareNoteArgs ¶
type ShareNoteArgs struct {}
func NewShareNoteArgs ¶
func NewShareNoteArgs() *ShareNoteArgs
func (*ShareNoteArgs) String ¶
func (p *ShareNoteArgs) String() string
type ShareNoteResult ¶
type ShareNoteResult struct {}
func NewShareNoteResult ¶
func NewShareNoteResult() *ShareNoteResult
func (*ShareNoteResult) String ¶
func (p *ShareNoteResult) String() string
type StopSharingNoteArgs ¶
type StopSharingNoteArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewStopSharingNoteArgs ¶
func NewStopSharingNoteArgs() *StopSharingNoteArgs
func (*StopSharingNoteArgs) String ¶
func (p *StopSharingNoteArgs) String() string
type StopSharingNoteResult ¶
type StopSharingNoteResult struct { UserException *Errors.EDAMUserException `thrift:"userException,1"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,2"` SystemException *Errors.EDAMSystemException `thrift:"systemException,3"` }
func NewStopSharingNoteResult ¶
func NewStopSharingNoteResult() *StopSharingNoteResult
func (*StopSharingNoteResult) String ¶
func (p *StopSharingNoteResult) String() string
type SyncChunk ¶
type SyncChunk struct { CurrentTime Types.Timestamp `thrift:"currentTime,1,required"` ChunkHighUSN int32 `thrift:"chunkHighUSN,2"` UpdateCount int32 `thrift:"updateCount,3,required"` Notes []*Types.Note `thrift:"notes,4"` Notebooks []*Types.Notebook `thrift:"notebooks,5"` Tags []*Types.Tag `thrift:"tags,6"` Searches []*Types.SavedSearch `thrift:"searches,7"` Resources []*Types.Resource `thrift:"resources,8"` ExpungedNotes []Types.Guid `thrift:"expungedNotes,9"` ExpungedNotebooks []Types.Guid `thrift:"expungedNotebooks,10"` ExpungedTags []Types.Guid `thrift:"expungedTags,11"` ExpungedSearches []Types.Guid `thrift:"expungedSearches,12"` LinkedNotebooks []*Types.LinkedNotebook `thrift:"linkedNotebooks,13"` ExpungedLinkedNotebooks []Types.Guid `thrift:"expungedLinkedNotebooks,14"` }
func NewSyncChunk ¶
func NewSyncChunk() *SyncChunk
func (*SyncChunk) IsSetChunkHighUSN ¶
func (*SyncChunk) IsSetExpungedLinkedNotebooks ¶
func (*SyncChunk) IsSetExpungedNotebooks ¶
func (*SyncChunk) IsSetExpungedNotes ¶
func (*SyncChunk) IsSetExpungedSearches ¶
func (*SyncChunk) IsSetExpungedTags ¶
func (*SyncChunk) IsSetLinkedNotebooks ¶
func (*SyncChunk) IsSetNotebooks ¶
func (*SyncChunk) IsSetNotes ¶
func (*SyncChunk) IsSetResources ¶
func (*SyncChunk) IsSetSearches ¶
type SyncChunkFilter ¶
type SyncChunkFilter struct { IncludeNotes bool `thrift:"includeNotes,1"` IncludeNoteResources bool `thrift:"includeNoteResources,2"` IncludeNoteAttributes bool `thrift:"includeNoteAttributes,3"` IncludeNotebooks bool `thrift:"includeNotebooks,4"` IncludeTags bool `thrift:"includeTags,5"` IncludeSearches bool `thrift:"includeSearches,6"` IncludeResources bool `thrift:"includeResources,7"` IncludeLinkedNotebooks bool `thrift:"includeLinkedNotebooks,8"` IncludeExpunged bool `thrift:"includeExpunged,9"` IncludeNoteApplicationDataFullMap bool `thrift:"includeNoteApplicationDataFullMap,10"` RequireNoteContentClass string `thrift:"requireNoteContentClass,11"` IncludeResourceApplicationDataFullMap bool `thrift:"includeResourceApplicationDataFullMap,12"` IncludeNoteResourceApplicationDataFullMap bool `thrift:"includeNoteResourceApplicationDataFullMap,13"` }
func NewSyncChunkFilter ¶
func NewSyncChunkFilter() *SyncChunkFilter
func (*SyncChunkFilter) IsSetIncludeExpunged ¶
func (p *SyncChunkFilter) IsSetIncludeExpunged() bool
func (*SyncChunkFilter) IsSetIncludeLinkedNotebooks ¶
func (p *SyncChunkFilter) IsSetIncludeLinkedNotebooks() bool
func (*SyncChunkFilter) IsSetIncludeNoteApplicationDataFullMap ¶
func (p *SyncChunkFilter) IsSetIncludeNoteApplicationDataFullMap() bool
func (*SyncChunkFilter) IsSetIncludeNoteAttributes ¶
func (p *SyncChunkFilter) IsSetIncludeNoteAttributes() bool
func (*SyncChunkFilter) IsSetIncludeNoteResourceApplicationDataFullMap ¶
func (p *SyncChunkFilter) IsSetIncludeNoteResourceApplicationDataFullMap() bool
func (*SyncChunkFilter) IsSetIncludeNoteResources ¶
func (p *SyncChunkFilter) IsSetIncludeNoteResources() bool
func (*SyncChunkFilter) IsSetIncludeNotebooks ¶
func (p *SyncChunkFilter) IsSetIncludeNotebooks() bool
func (*SyncChunkFilter) IsSetIncludeNotes ¶
func (p *SyncChunkFilter) IsSetIncludeNotes() bool
func (*SyncChunkFilter) IsSetIncludeResourceApplicationDataFullMap ¶
func (p *SyncChunkFilter) IsSetIncludeResourceApplicationDataFullMap() bool
func (*SyncChunkFilter) IsSetIncludeResources ¶
func (p *SyncChunkFilter) IsSetIncludeResources() bool
func (*SyncChunkFilter) IsSetIncludeSearches ¶
func (p *SyncChunkFilter) IsSetIncludeSearches() bool
func (*SyncChunkFilter) IsSetIncludeTags ¶
func (p *SyncChunkFilter) IsSetIncludeTags() bool
func (*SyncChunkFilter) IsSetRequireNoteContentClass ¶
func (p *SyncChunkFilter) IsSetRequireNoteContentClass() bool
func (*SyncChunkFilter) String ¶
func (p *SyncChunkFilter) String() string
type SyncState ¶
type SyncState struct { CurrentTime Types.Timestamp `thrift:"currentTime,1,required"` FullSyncBefore Types.Timestamp `thrift:"fullSyncBefore,2,required"` UpdateCount int32 `thrift:"updateCount,3,required"` Uploaded int64 `thrift:"uploaded,4"` }
func NewSyncState ¶
func NewSyncState() *SyncState
func (*SyncState) IsSetUploaded ¶
type UnsetNoteApplicationDataEntryArgs ¶
type UnsetNoteApplicationDataEntryArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` Key string `thrift:"key,3"` }
func NewUnsetNoteApplicationDataEntryArgs ¶
func NewUnsetNoteApplicationDataEntryArgs() *UnsetNoteApplicationDataEntryArgs
func (*UnsetNoteApplicationDataEntryArgs) String ¶
func (p *UnsetNoteApplicationDataEntryArgs) String() string
type UnsetNoteApplicationDataEntryResult ¶
type UnsetNoteApplicationDataEntryResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewUnsetNoteApplicationDataEntryResult ¶
func NewUnsetNoteApplicationDataEntryResult() *UnsetNoteApplicationDataEntryResult
func (*UnsetNoteApplicationDataEntryResult) String ¶
func (p *UnsetNoteApplicationDataEntryResult) String() string
type UnsetResourceApplicationDataEntryArgs ¶
type UnsetResourceApplicationDataEntryArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` Key string `thrift:"key,3"` }
func NewUnsetResourceApplicationDataEntryArgs ¶
func NewUnsetResourceApplicationDataEntryArgs() *UnsetResourceApplicationDataEntryArgs
func (*UnsetResourceApplicationDataEntryArgs) String ¶
func (p *UnsetResourceApplicationDataEntryArgs) String() string
type UnsetResourceApplicationDataEntryResult ¶
type UnsetResourceApplicationDataEntryResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewUnsetResourceApplicationDataEntryResult ¶
func NewUnsetResourceApplicationDataEntryResult() *UnsetResourceApplicationDataEntryResult
func (*UnsetResourceApplicationDataEntryResult) String ¶
func (p *UnsetResourceApplicationDataEntryResult) String() string
type UntagAllArgs ¶
type UntagAllArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Guid Types.Guid `thrift:"guid,2"` }
func NewUntagAllArgs ¶
func NewUntagAllArgs() *UntagAllArgs
func (*UntagAllArgs) String ¶
func (p *UntagAllArgs) String() string
type UntagAllResult ¶
type UntagAllResult struct { UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewUntagAllResult ¶
func NewUntagAllResult() *UntagAllResult
func (*UntagAllResult) String ¶
func (p *UntagAllResult) String() string
type UpdateLinkedNotebookArgs ¶
type UpdateLinkedNotebookArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` LinkedNotebook *Types.LinkedNotebook `thrift:"linkedNotebook,2"` }
func NewUpdateLinkedNotebookArgs ¶
func NewUpdateLinkedNotebookArgs() *UpdateLinkedNotebookArgs
func (*UpdateLinkedNotebookArgs) String ¶
func (p *UpdateLinkedNotebookArgs) String() string
type UpdateLinkedNotebookResult ¶
type UpdateLinkedNotebookResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,2"` SystemException *Errors.EDAMSystemException `thrift:"systemException,3"` }
func NewUpdateLinkedNotebookResult ¶
func NewUpdateLinkedNotebookResult() *UpdateLinkedNotebookResult
func (*UpdateLinkedNotebookResult) String ¶
func (p *UpdateLinkedNotebookResult) String() string
type UpdateNoteArgs ¶
type UpdateNoteArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Note *Types.Note `thrift:"note,2"` }
func NewUpdateNoteArgs ¶
func NewUpdateNoteArgs() *UpdateNoteArgs
func (*UpdateNoteArgs) String ¶
func (p *UpdateNoteArgs) String() string
type UpdateNoteResult ¶
type UpdateNoteResult struct { Success *Types.Note `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewUpdateNoteResult ¶
func NewUpdateNoteResult() *UpdateNoteResult
func (*UpdateNoteResult) String ¶
func (p *UpdateNoteResult) String() string
type UpdateNotebookArgs ¶
type UpdateNotebookArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Notebook *Types.Notebook `thrift:"notebook,2"` }
func NewUpdateNotebookArgs ¶
func NewUpdateNotebookArgs() *UpdateNotebookArgs
func (*UpdateNotebookArgs) String ¶
func (p *UpdateNotebookArgs) String() string
type UpdateNotebookResult ¶
type UpdateNotebookResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewUpdateNotebookResult ¶
func NewUpdateNotebookResult() *UpdateNotebookResult
func (*UpdateNotebookResult) String ¶
func (p *UpdateNotebookResult) String() string
type UpdateResourceArgs ¶
type UpdateResourceArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Resource *Types.Resource `thrift:"resource,2"` }
func NewUpdateResourceArgs ¶
func NewUpdateResourceArgs() *UpdateResourceArgs
func (*UpdateResourceArgs) String ¶
func (p *UpdateResourceArgs) String() string
type UpdateResourceResult ¶
type UpdateResourceResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewUpdateResourceResult ¶
func NewUpdateResourceResult() *UpdateResourceResult
func (*UpdateResourceResult) String ¶
func (p *UpdateResourceResult) String() string
type UpdateSearchArgs ¶
type UpdateSearchArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Search *Types.SavedSearch `thrift:"search,2"` }
func NewUpdateSearchArgs ¶
func NewUpdateSearchArgs() *UpdateSearchArgs
func (*UpdateSearchArgs) String ¶
func (p *UpdateSearchArgs) String() string
type UpdateSearchResult ¶
type UpdateSearchResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewUpdateSearchResult ¶
func NewUpdateSearchResult() *UpdateSearchResult
func (*UpdateSearchResult) String ¶
func (p *UpdateSearchResult) String() string
type UpdateSharedNotebookArgs ¶
type UpdateSharedNotebookArgs struct {}
func NewUpdateSharedNotebookArgs ¶
func NewUpdateSharedNotebookArgs() *UpdateSharedNotebookArgs
func (*UpdateSharedNotebookArgs) String ¶
func (p *UpdateSharedNotebookArgs) String() string
type UpdateSharedNotebookResult ¶
type UpdateSharedNotebookResult struct {}
func NewUpdateSharedNotebookResult ¶
func NewUpdateSharedNotebookResult() *UpdateSharedNotebookResult
func (*UpdateSharedNotebookResult) String ¶
func (p *UpdateSharedNotebookResult) String() string
type UpdateTagArgs ¶
type UpdateTagArgs struct { AuthenticationToken string `thrift:"authenticationToken,1"` Tag *Types.Tag `thrift:"tag,2"` }
func NewUpdateTagArgs ¶
func NewUpdateTagArgs() *UpdateTagArgs
func (*UpdateTagArgs) String ¶
func (p *UpdateTagArgs) String() string
type UpdateTagResult ¶
type UpdateTagResult struct { Success int32 `thrift:"success,0"` UserException *Errors.EDAMUserException `thrift:"userException,1"` SystemException *Errors.EDAMSystemException `thrift:"systemException,2"` NotFoundException *Errors.EDAMNotFoundException `thrift:"notFoundException,3"` }
func NewUpdateTagResult ¶
func NewUpdateTagResult() *UpdateTagResult
func (*UpdateTagResult) String ¶
func (p *UpdateTagResult) String() string