AddTagConfig

Config object for adding a tag to an object. It contains objectType, rowId, userId, tagType and tagTitle which are set with the corresponding functions.

Methods

setObjectType

setObjectType(pObjectType): AddTagConfig

Required parameter

Parameters

pObjectType

string | number | boolean

The type of the object to be tagged. For example "Organisation".

Returns

AddTagConfig

The current config

---

setRowId

setRowId(pRowId): AddTagConfig

Required parameter

Parameters

pRowId

string | number | boolean

The id of the dataset to be tagged.

Returns

AddTagConfig

The current config

---

setTagTitle

setTagTitle(pTagTitle): AddTagConfig

Optional parameter

Parameters

pTagTitle

string | number | boolean

The title of the tag the tagged object will belong to. Only necessary if pTagType != DEFAULT_FAVORITE_GROUP.

Returns

AddTagConfig

The current config

---

setTagType

setTagType(pTagType): AddTagConfig

Required parameter

Parameters

pTagType

string | number | boolean

One of the tag types. For example tag.DEFAULT_FAVORITE_GROUP

Returns

AddTagConfig

The current config

---

setUserId

setUserId(pUserId): AddTagConfig

Required parameter

Parameters

pUserId

string | number | boolean

The id of the user the tagged object will belong to.

Returns

AddTagConfig

The current config