To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A profile-specific timeline event, extending StreamEventBean with a flag for whether the action was inbound (from the user to the platform) or outbound (from the platform or organisation to the user).
Extends: StreamEventBean
Properties
| Property | Returns | Description |
|---|---|---|
| inbound | boolean | Whether this action was inbound, ie initiated by the user towards the platform, as opposed to outbound. |
Inherited from StreamEventBean
Properties
| Property | Returns | Description |
|---|---|---|
| actionDate | Date | The date and time this event occurred, used to order it on the timeline. |
| actionDesc | String | The short description of this event, for example "edited" or "sent email". |
| branch | Branch | The branch this event relates to. |
| category | String | The bootstrap contextual class used to style this event on the timeline, such as muted or primary. |
| data | Map | Arbitrary additional data associated with this event. |
| itemTitle | String | The title of the item this event relates to, shown on the timeline entry. |
| itemType | String | The font-awesome icon name set on this event. Despite the getter's name, this returns the action icon (set via icon(String) or setActionIcon(String)), not an item type. |
| itemTypeIcon | String | The icon representing the type of item this event relates to. |
| org | Organisation | The organisation this event belongs to. |
| path | String | The path used to link to the item this event relates to. |
| repo | Repository | The repository this event relates to. |
| user | Profile | The profile this event is associated with. |
Methods
date(Date d) · category(String s) · icon(String s) · desc(String s) · path(String s) · title(String s) · itemTypeIcon(String s) · repo(Repository s) · branch(Branch s) · inbound(Boolean b) · data(Map data) · getCategory() · setCategory(String category) · getItemType() · setActionIcon(String itemType) · getActionDesc() · setActionDesc(String action) · getPath() · setPath(String path) · getItemTitle() · setItemTitle(String itemTitle) · getItemTypeIcon() · setItemTypeIcon(String itemTypeIcon) · getUser() · getRepo() · setRepo(Repository repo) · getBranch() · setBranch(Branch branch) · getOrg() · getData() · getInbound() · getActionDate()
date(Date d)
Returns: StreamEventBean
Sets the date this event occurred, used to order and display the event on the timeline.
| Parameter | Description |
|---|---|
d | the date and time of the event |
category(String s)
Returns: StreamEventBean
Sets the category of this event, used to style it on the timeline. Should be one of the bootstrap contextual classes, such as muted or primary.
| Parameter | Description |
|---|---|
s | the bootstrap contextual class name for this event |
icon(String s)
Returns: StreamEventBean
Sets the icon shown for this event on the timeline. Should correspond to the name of a font-awesome icon.
| Parameter | Description |
|---|---|
s | the font-awesome icon name |
desc(String s)
Returns: StreamEventBean
Sets the short description of this event, for example "edited", "started job" or "sent email".
| Parameter | Description |
|---|---|
s | the description text |
path(String s)
Returns: StreamEventBean
Sets the path used to link to the item this event relates to.
| Parameter | Description |
|---|---|
s | the path to link to |
title(String s)
Returns: StreamEventBean
Sets the title of the item this event relates to, shown on the timeline entry.
| Parameter | Description |
|---|---|
s | the item title |
itemTypeIcon(String s)
Returns: StreamEventBean
Sets the icon representing the type of item this event relates to, shown alongside the event on the timeline.
| Parameter | Description |
|---|---|
s | the item type icon name |
repo(Repository s)
Returns: StreamEventBean
Sets the repository this event relates to.
| Parameter | Description |
|---|---|
s | the repository the event occurred in |
branch(Branch s)
Returns: StreamEventBean
Sets the branch this event relates to.
| Parameter | Description |
|---|---|
s | the branch the event occurred in |
inbound(Boolean b)
Returns: StreamEventBean
Sets whether this event represents an action coming from the user to the server, as opposed to an outbound action pushed from the server to the user.
| Parameter | Description |
|---|---|
b | true if the event is inbound from the user, false if it is outbound from the server |
data(Map data)
Returns: StreamEventBean
Sets arbitrary additional data associated with this event.
| Parameter | Description |
|---|---|
data | a map of extra data for this event |
getCategory()
Returns: String
The bootstrap contextual class used to style this event on the timeline, such as muted or primary.
setCategory(String category)
Returns: void
Sets the bootstrap contextual class used to style this event on the timeline.
| Parameter | Description |
|---|---|
category | the category name to set |
getItemType()
Returns: String
The font-awesome icon name set on this event. Despite the getter's name, this returns the action icon (set via icon(String) or setActionIcon(String)), not an item type.
setActionIcon(String itemType)
Returns: void
Sets the font-awesome icon name for this event.
| Parameter | Description |
|---|---|
itemType | the icon name to set |
getActionDesc()
Returns: String
The short description of this event, for example "edited" or "sent email".
setActionDesc(String action)
Returns: void
Sets the short description of this event.
| Parameter | Description |
|---|---|
action | the description text to set |
getPath()
Returns: String
The path used to link to the item this event relates to.
setPath(String path)
Returns: void
Sets the path used to link to the item this event relates to.
| Parameter | Description |
|---|---|
path | the item path to set |
getItemTitle()
Returns: String
The title of the item this event relates to, shown on the timeline entry.
setItemTitle(String itemTitle)
Returns: void
Sets the title of the item this event relates to.
| Parameter | Description |
|---|---|
itemTitle | the item title to set |
getItemTypeIcon()
Returns: String
The icon representing the type of item this event relates to.
setItemTypeIcon(String itemTypeIcon)
Returns: void
Sets the icon representing the type of item this event relates to.
| Parameter | Description |
|---|---|
itemTypeIcon | the item type icon name to set |
getUser()
Returns: Profile
The profile this event is associated with.
getRepo()
Returns: Repository
The repository this event relates to.
setRepo(Repository repo)
Returns: void
Sets the repository this event relates to.
| Parameter | Description |
|---|---|
repo | the repository to set |
getBranch()
Returns: Branch
The branch this event relates to.
setBranch(Branch branch)
Returns: void
Sets the branch this event relates to.
| Parameter | Description |
|---|---|
branch | the branch to set |
getOrg()
Returns: Organisation
The organisation this event belongs to.
getData()
Returns: Map
Arbitrary additional data associated with this event.
getInbound()
Returns: Boolean
Whether this event represents an action coming from the user to the server, as opposed to an outbound action pushed from the server to the user.
getActionDate()
Returns: Date
The date and time this event occurred, used to order it on the timeline.
Methods
isInbound()
Returns: boolean
Whether this action was inbound, ie initiated by the user towards the platform, as opposed to outbound.
© 2025 Kademi Ltd