-
Notifications
You must be signed in to change notification settings - Fork 292
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(common): update server API reference for R1 2019
- Loading branch information
1 parent
9e04e42
commit e6ddf6e
Showing
37 changed files
with
1,895 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.Animation | ||
page_title: Telerik.Web.UI.Chat.Animation | ||
description: Telerik.Web.UI.Chat.Animation | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.Animation | ||
|
||
Configures the toolbar toggle animation. If disabled animation will not play. | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager | ||
* Telerik.Web.UI.Chat.Animation : IDefaultCheck | ||
|
||
## Properties | ||
|
||
### CollapseSettings `Collapse` | ||
|
||
Configures the toolbar collapse animation. | ||
|
||
### ExpandSettings `Expand` | ||
|
||
Configures the expand animation of the toolbar; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.AnimationConverter | ||
page_title: Telerik.Web.UI.Chat.AnimationConverter | ||
description: Telerik.Web.UI.Chat.AnimationConverter | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.AnimationConverter | ||
|
||
Serialization JS converter class for Animation | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* System.Web.Script.Serialization.JavaScriptConverter | ||
* Telerik.Web.UI.ExplicitJavaScriptConverter | ||
* Telerik.Web.UI.Chat.AnimationConverter | ||
|
||
## Methods | ||
|
||
### AddScript | ||
|
||
Serialize the value as a script, not a string. Should be used alongside with | ||
|
||
#### Parameters | ||
|
||
#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` | ||
|
||
The state collection for the values | ||
|
||
#### key `System.String` | ||
|
||
The key in the JSON object | ||
|
||
#### value `System.Object` | ||
|
||
The value in the JSON obejct | ||
|
||
#### Returns | ||
|
||
`System.Void` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.ChatToolbar | ||
page_title: Telerik.Web.UI.Chat.ChatToolbar | ||
description: Telerik.Web.UI.Chat.ChatToolbar | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.ChatToolbar | ||
|
||
Configures the Kedno UI Chat toolbar. | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager | ||
* Telerik.Web.UI.Chat.ChatToolbar : IDefaultCheck | ||
|
||
## Properties | ||
|
||
### Animation `Boolean` | ||
|
||
Configures the toolbar toggle animation. If disabled animation will not play. | ||
|
||
### AnimationSettings `Boolean` | ||
|
||
Configures the toolbar toggle animation. If disabled animation will not play. | ||
|
||
### ButtonsCollection `ChatToolbarButtonsCollection` | ||
|
||
Defines the collection of buttons to be rendered. | ||
|
||
### Scrollable `Boolean` | ||
|
||
Enables or disables the scrollable behavior of the toolbar. | ||
|
||
### Toggleable `Boolean` | ||
|
||
Enables or disables the toggleable behavior of the toolbar. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.ChatToolbarConverter | ||
page_title: Telerik.Web.UI.Chat.ChatToolbarConverter | ||
description: Telerik.Web.UI.Chat.ChatToolbarConverter | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.ChatToolbarConverter | ||
|
||
Serialization JS converter class for Toolbar | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* System.Web.Script.Serialization.JavaScriptConverter | ||
* Telerik.Web.UI.ExplicitJavaScriptConverter | ||
* Telerik.Web.UI.Chat.ChatToolbarConverter | ||
|
||
## Methods | ||
|
||
### AddScript | ||
|
||
Serialize the value as a script, not a string. Should be used alongside with | ||
|
||
#### Parameters | ||
|
||
#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` | ||
|
||
The state collection for the values | ||
|
||
#### key `System.String` | ||
|
||
The key in the JSON object | ||
|
||
#### value `System.Object` | ||
|
||
The value in the JSON obejct | ||
|
||
#### Returns | ||
|
||
`System.Void` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.Collapse | ||
page_title: Telerik.Web.UI.Chat.Collapse | ||
description: Telerik.Web.UI.Chat.Collapse | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.Collapse | ||
|
||
Configures the toolbar collapse animation. | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager | ||
* Telerik.Web.UI.Chat.Collapse : IDefaultCheck | ||
|
||
## Properties | ||
|
||
### Duration `Double` | ||
|
||
Configures the duration (in miliseconds) of the toolbar collapse animation. | ||
|
||
### Effects `String` | ||
|
||
Configures the effects of the toolbar collapse animation. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.CollapseConverter | ||
page_title: Telerik.Web.UI.Chat.CollapseConverter | ||
description: Telerik.Web.UI.Chat.CollapseConverter | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.CollapseConverter | ||
|
||
Serialization JS converter class for Collapse | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* System.Web.Script.Serialization.JavaScriptConverter | ||
* Telerik.Web.UI.ExplicitJavaScriptConverter | ||
* Telerik.Web.UI.Chat.CollapseConverter | ||
|
||
## Methods | ||
|
||
### AddScript | ||
|
||
Serialize the value as a script, not a string. Should be used alongside with | ||
|
||
#### Parameters | ||
|
||
#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` | ||
|
||
The state collection for the values | ||
|
||
#### key `System.String` | ||
|
||
The key in the JSON object | ||
|
||
#### value `System.Object` | ||
|
||
The value in the JSON obejct | ||
|
||
#### Returns | ||
|
||
`System.Void` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.Expand | ||
page_title: Telerik.Web.UI.Chat.Expand | ||
description: Telerik.Web.UI.Chat.Expand | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.Expand | ||
|
||
Configures the expand animation of the toolbar; | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager | ||
* Telerik.Web.UI.Chat.Expand : IDefaultCheck | ||
|
||
## Properties | ||
|
||
### Duration `Double` | ||
|
||
Configures the duration of the expand animation. | ||
|
||
### Effects `String` | ||
|
||
Configures the effects of the expand animation. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.ExpandConverter | ||
page_title: Telerik.Web.UI.Chat.ExpandConverter | ||
description: Telerik.Web.UI.Chat.ExpandConverter | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.ExpandConverter | ||
|
||
Serialization JS converter class for Expand | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* System.Web.Script.Serialization.JavaScriptConverter | ||
* Telerik.Web.UI.ExplicitJavaScriptConverter | ||
* Telerik.Web.UI.Chat.ExpandConverter | ||
|
||
## Methods | ||
|
||
### AddScript | ||
|
||
Serialize the value as a script, not a string. Should be used alongside with | ||
|
||
#### Parameters | ||
|
||
#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` | ||
|
||
The state collection for the values | ||
|
||
#### key `System.String` | ||
|
||
The key in the JSON object | ||
|
||
#### value `System.Object` | ||
|
||
The value in the JSON obejct | ||
|
||
#### Returns | ||
|
||
`System.Void` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.Messages | ||
page_title: Telerik.Web.UI.Chat.Messages | ||
description: Telerik.Web.UI.Chat.Messages | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.Messages | ||
|
||
Allows localization of the strings that are used in the widget. | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager | ||
* Telerik.Web.UI.Chat.Messages : IDefaultCheck | ||
|
||
## Properties | ||
|
||
### Placeholder `String` | ||
|
||
The hint displayed in the input textbox of the widget. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.MessagesConverter | ||
page_title: Telerik.Web.UI.Chat.MessagesConverter | ||
description: Telerik.Web.UI.Chat.MessagesConverter | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.MessagesConverter | ||
|
||
Serialization JS converter class for Messages | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* System.Web.Script.Serialization.JavaScriptConverter | ||
* Telerik.Web.UI.ExplicitJavaScriptConverter | ||
* Telerik.Web.UI.Chat.MessagesConverter | ||
|
||
## Methods | ||
|
||
### AddScript | ||
|
||
Serialize the value as a script, not a string. Should be used alongside with | ||
|
||
#### Parameters | ||
|
||
#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` | ||
|
||
The state collection for the values | ||
|
||
#### key `System.String` | ||
|
||
The key in the JSON object | ||
|
||
#### value `System.Object` | ||
|
||
The value in the JSON obejct | ||
|
||
#### Returns | ||
|
||
`System.Void` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: Telerik.Web.UI.Chat.User | ||
page_title: Telerik.Web.UI.Chat.User | ||
description: Telerik.Web.UI.Chat.User | ||
--- | ||
|
||
# Telerik.Web.UI.Chat.User | ||
|
||
Configures the Kendo UI Chat user information. | ||
|
||
## Inheritance Hierarchy | ||
|
||
* System.Object | ||
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager | ||
* Telerik.Web.UI.Chat.User : IDefaultCheck | ||
|
||
## Properties | ||
|
||
### IconUrl `String` | ||
|
||
If set, sets the image url to be used for the user avatar icon. | ||
|
||
### Name `String` | ||
|
||
Sets the name of the chat user. | ||
|
Oops, something went wrong.