new InboxQuery()
AV.InboxQuery defines a query that is used to fetch somebody's inbox statuses.
Methods
inboxType(type) → {AV.InboxQuery}
Sets the querying inbox type.default is 'default'.
Parameters:
| Name | Type | Description |
|---|---|---|
type |
String | The inbox type. |
Returns:
Returns the query, so you can chain this call.
- Type
- AV.InboxQuery
maxId(n) → {AV.InboxQuery}
Sets the maximal messageId of results。
This is useful for pagination.
Default is zero that is no limition.
Parameters:
| Name | Type | Description |
|---|---|---|
n |
Number | the mesage id. |
Returns:
Returns the query, so you can chain this call.
- Type
- AV.InboxQuery
owner(owner) → {AV.InboxQuery}
Sets the owner of the querying inbox.
Parameters:
| Name | Type | Description |
|---|---|---|
owner |
AV.User | The inbox owner. |
Returns:
Returns the query, so you can chain this call.
- Type
- AV.InboxQuery
sinceId(n) → {AV.InboxQuery}
Sets the messageId of results to skip before returning any results.
This is useful for pagination.
Default is zero.
Parameters:
| Name | Type | Description |
|---|---|---|
n |
Number | the mesage id. |
Returns:
Returns the query, so you can chain this call.
- Type
- AV.InboxQuery