public class GetAllInboxItemsRequest
extends java.lang.Object
A request for all inbox items. The request can screen for
tasks, notifications, or both depending on the selection set using
setMode(int)
.
Member Variable | Description |
String ticket |
An authentication ticket |
String [] users |
An array of user IDs. |
int mode | Mode 1 returns work items, mode 2 returns notifications, and mode 3 returns both |
String taskObjType |
Task object type. |
String [] taskAddlAttr |
Additional Task Attributes. NULLABLE. |
String notifObjType |
Notification object type. NULLABLE. |
String [] notifAddlAttr |
Additional Notification Attributes. NULLABLE. |
Boolean containsRepeatingTaskAttrs |
True if object contains repeating task attributes |
Boolean containsRepeatingNotifAttrs |
True if object contains repeating notification attributes |
Modifier and Type | Class and Description |
---|---|
static class |
GetAllInboxItemsRequest.Mode |
Constructor and Description |
---|
GetAllInboxItemsRequest() |
Modifier and Type | Method and Description |
---|---|
int |
getMode() |
java.lang.String[] |
getNotifAddlAttr() |
java.lang.String |
getNotifObjType() |
java.lang.String[] |
getTaskAddlAttr() |
java.lang.String |
getTaskObjType() |
java.lang.String |
getTicket() |
java.lang.String[] |
getUsers() |
boolean |
isContainsRepeatingNotifAttrs() |
boolean |
isContainsRepeatingTaskAttrs() |
void |
setContainsRepeatingNotifAttrs(boolean containsRepeatingNotifAttrs) |
void |
setContainsRepeatingTaskAttrs(boolean containsRepeatingTaskAttrs) |
void |
setMode(int mode) |
void |
setNotifAddlAttr(java.lang.String[] notifAddlAttr) |
void |
setNotifObjType(java.lang.String notifObjType) |
void |
setTaskAddlAttr(java.lang.String[] taskAddlAttr) |
void |
setTaskObjType(java.lang.String taskObjType) |
void |
setTicket(java.lang.String ticket)
Set the authentication ticket for this request.
|
void |
setUsers(java.lang.String[] users) |
public java.lang.String getTicket()
public void setTicket(java.lang.String ticket)
ticket
- public java.lang.String[] getUsers()
public void setUsers(java.lang.String[] users)
public int getMode()
public void setMode(int mode)
public java.lang.String getTaskObjType()
public void setTaskObjType(java.lang.String taskObjType)
public java.lang.String[] getTaskAddlAttr()
public void setTaskAddlAttr(java.lang.String[] taskAddlAttr)
public java.lang.String getNotifObjType()
public void setNotifObjType(java.lang.String notifObjType)
public java.lang.String[] getNotifAddlAttr()
public void setNotifAddlAttr(java.lang.String[] notifAddlAttr)
public boolean isContainsRepeatingTaskAttrs()
public void setContainsRepeatingTaskAttrs(boolean containsRepeatingTaskAttrs)
public boolean isContainsRepeatingNotifAttrs()
public void setContainsRepeatingNotifAttrs(boolean containsRepeatingNotifAttrs)