Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Comment:
Migrated to Confluence 5.3
Excerpt |
---|
Extend the "Time to Live" of the most recent conversation with a conversationplayer. |
Syntax
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
chat.extend(player, ttl); |
Parameters
Parameter | Type | Mandatory | Notes | Chat Ver |
---|---|---|---|---|
player | Number | The ID of the player whose conversation will be extended. | 0.1 | |
ttl | Number | Time To Live (TTL) specified in milliseconds. Default: 15000 | 0.1 |
Return Values
Value | Type | Notes | Chat Ver |
---|---|---|---|
<error> | Error | Parameters specified were invalid (see error message for details) or the Conversation Handler Function for the player is missing or invalid. | 0.1 |
<cdo> | Conversation Descriptor Object | If the conversation was extended successfully, it's CDO will be returned. | 0.1 |
Example
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
// conversation with player 4 will be extended for 15 seconds from current time chat.extend(4); |
Div | ||
---|---|---|
| ||
The conversation cannot be extended if the CDO associated with the player has a missing or invalid Conversation Handler Function. Use chat.start() or directly modify the CDO (get it with chat.get()) to define the handler functionmust have a valid Conversation Handler Function before a conversation can be extended. |
Div | ||||||
---|---|---|---|---|---|---|
| ||||||
Availability
Requires:
|
Div | ||||
---|---|---|---|---|
| ||||
ContentsJump to:
|
Div | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
Chat APITopics:
|