ubs_message_recipient_ns

@unitybase/ubs~ ubs_message_recipient_ns

System messages recipients. System messages recipient

Constructor

new ubs_message_recipient_ns()

Mixes In:
mStorage   

Extends

Members

attrs static

Attributes defined in metadata. This property not exist in real life and added just for help

entity: UBEntity

Reference to entity metadata

Methods

addNew(ctx) api

Create record with filled default values and return it to caller. Newly created record is not inserted to database. For inserting record to the database insert method should be called
Arguments:
  1. ctx (ubMethodParams)
Mixes In:
mStorage.addNew   

delete(ctx) api

Delete data
Arguments:
  1. ctx (ubMethodParams)
    Properties
    1. mParams.execParams.ID (number)  element ID to be deleted
Mixes In:
mStorage.delete   

insert(ctx) api

Insert new row to the entity.
Arguments:
  1. ctx (ubMethodParams)
    Properties
    1. mParams.execParams (Object|TubList)  Object keys is entity attributes names, key values is a value to be inserted
Mixes In:
mStorage.insert   

select(ctx) api

Read entity data
Arguments:
  1. ctx (ubMethodParams)
    Properties
    1. mParams (UBQL)  ORM query in UBQL format
Mixes In:
mStorage.select   

update(ctx) api

Update data
Arguments:
  1. ctx (ubMethodParams)
    Properties
    1. mParams.execParams (Object|TubList)  Object keys is entity attributes names, key values is a value to be inserted
      Properties
      1. ID (number)  element ID to be updated
Mixes In:
mStorage.update   

accept(ctx) api

Mark message with specified ID as read by recipient (current logged in user)
Arguments:
  1. ctx (ubMethodParams)
    Properties
    1. mParams.execParams.ID (Number)

addRoles(ctx) api

Add all users with roles roles to a message recipient list
Arguments:
  1. ctx (ubMethodParams)
    Properties
    1. mParams.execParams.messageID (number)
    2. mParams.execParams.roles (string)  Comma separated role list

removeRoles(ctx) api

Add all users with roles roles to a message recipient list
Arguments:
  1. ctx (ubMethodParams)
    Properties
    1. mParams.execParams.messageID (number)
    2. mParams.execParams.roles (string)  Comma separated role list