Class XmppCollectionManager

constructor

• new XmppCollectionManager(ctx: XmppCollectionContext): XmppCollectionManager

  Parameters

  • ctx: XmppCollectionContext

  Returns XmppCollectionManager

ReadonlyattachmentHistory

ReadonlycollectionFeedIndex

ReadonlycollectionHistory

Readonlycollections

ReadonlycollectionSubscriptions

addFeedToCollection

• addFeedToCollection(
      collectionId: string,
      peerAddr: string | Multiaddr,
  ): Promise<XmppCollectionNode>

  Parameters

  • collectionId: string
  • peerAddr: string | Multiaddr

  Returns Promise<XmppCollectionNode>

buildAttachmentSummary

• buildAttachmentSummary(topic: string, targetId: string): XmppAttachmentSummary

  Parameters

  • topic: string
  • targetId: string

  Returns XmppAttachmentSummary

close

• close(): Promise<void>

  Returns Promise<void>

createCollection

• createCollection(id: string, name?: string): Promise<XmppCollectionNode>

  Parameters

  • id: string
  • Optionalname: string

  Returns Promise<XmppCollectionNode>

getAttachments

• getAttachments(topic?: string, targetId?: string): Promise<XmppAttachment[]>

  Parameters

  • Optionaltopic: string
  • OptionaltargetId: string

  Returns Promise<XmppAttachment[]>

getAttachmentSummaries

• getAttachmentSummaries(topic?: string): Promise<XmppAttachmentSummary[]>

  Parameters

  • Optionaltopic: string

  Returns Promise<XmppAttachmentSummary[]>

getCollectionPosts

• getCollectionPosts(collectionId?: string): Promise<XmppCollectionPost[]>

  Parameters

  • OptionalcollectionId: string

  Returns Promise<XmppCollectionPost[]>

getCollections

• getCollections(): Promise<XmppCollectionNode[]>

  Returns Promise<XmppCollectionNode[]>

getCollectionSubscriptions

• getCollectionSubscriptions(): Promise<XmppCollectionSubscription[]>

  Returns Promise<XmppCollectionSubscription[]>

indexCollectionMembers

• indexCollectionMembers(collection: XmppCollectionNode): void

  Parameters

  • collection: XmppCollectionNode

  Returns void

initialize

• initialize(): Promise<void>

  Returns Promise<void>

persistAttachmentHistory

• persistAttachmentHistory(): Promise<void>

  Returns Promise<void>

persistCollectionState

• persistCollectionState(): Promise<void>

  Returns Promise<void>

publishAttachment

• publishAttachment(
      topic: string,
      targetId: string,
      kind: XmppAttachmentKind,
      value?: string,
      options?: { itemId?: string },
  ): Promise<string>

  Parameters

  • topic: string
  • targetId: string
  • kind: XmppAttachmentKind
  • Optionalvalue: string
  • options: { itemId?: string } = {}

  Returns Promise<string>

publishCollection

• publishCollection(
      id: string,
      body: string,
      options?: {
          author?: string;
          categories?: string[];
          itemId?: string;
          summary?: string;
          title?: string;
      },
  ): Promise<string>

  Parameters

  • id: string
  • body: string
  • options: {
        author?: string;
        categories?: string[];
        itemId?: string;
        summary?: string;
        title?: string;
    } = {}

  Returns Promise<string>

publishCollectionPost

• publishCollectionPost(
      collectionId: string,
      feedPost: XmppFeedPost,
  ): Promise<string>

  Parameters

  • collectionId: string
  • feedPost: XmppFeedPost

  Returns Promise<string>

recordAttachment

• recordAttachment(attachment: XmppAttachment): Promise<boolean>

  Parameters

  • attachment: XmppAttachment

  Returns Promise<boolean>

recordCollectionPost

• recordCollectionPost(post: XmppCollectionPost): Promise<boolean>

  Parameters

  • post: XmppCollectionPost

  Returns Promise<boolean>

restoreCollectionSubscriptions

• restoreCollectionSubscriptions(): Promise<void>

  Returns Promise<void>

scheduleAttachmentPersist

• scheduleAttachmentPersist(): Promise<void>

  Returns Promise<void>

scheduleCollectionPersist

• scheduleCollectionPersist(): Promise<void>

  Returns Promise<void>

subscribeCollection

• subscribeCollection(id: string): Promise<XmppCollectionSubscription>

  Parameters

  • id: string

  Returns Promise<XmppCollectionSubscription>

unindexCollectionMembers

• unindexCollectionMembers(collection: XmppCollectionNode): void

  Parameters

  • collection: XmppCollectionNode

  Returns void

unsubscribeCollection

• unsubscribeCollection(id: string): Promise<void>

  Parameters

  • id: string

  Returns Promise<void>