Home Reference Source
import MessageFolder from 'magister.js/src/messageFolder.js'
public class | source

MessageFolder

Extends:

MagisterThing → MessageFolder

Member Summary

Public Members
public
public
public
public
public

Method Summary

Public Methods
public
public

Inherited Summary

From class MagisterThing
public

Public Members

public id: String source

public name: String source

public parentId: String source

public type: String source

public unreadCount: Number source

Public Methods

public messages(options: Object): Promise<Object> source

Params:

NameTypeAttributeDescription
options Object
  • optional
  • default: {}
options.count Number
  • optional
  • default: 10

The limit of the amount of Messages to fetch. If null, all messages will be downloaded form the server.

options.skip Number
  • optional
  • default: 0

The amount of messages in front of the MessageFolder to skip.

options.readState String
  • optional
  • default: 'all'

One of: 'all', 'read', 'unread'.

options.fill Boolean
  • optional
  • default: true

Whether or not to call fill on every message.

options.fillPersons Boolean
  • optional
  • default: false

Whether or not to download the users from the server. options.fill has to be true for this option to take effect.

Return:

Promise<Object>

{ messages: Message[], totalCount: Number }

public toJSON(): Object source

Override:

MagisterThing#toJSON

Return:

Object