Skip to content
This repository has been archived by the owner on May 30, 2023. It is now read-only.

Commit

Permalink
Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
wangyung committed Sep 21, 2018
1 parent 26a5c6d commit 59cef6d
Show file tree
Hide file tree
Showing 188 changed files with 1,378 additions and 17 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ repositories {
dependencies {
//Mandatory
implementation "com.linecorp:clova-extension-core:1.0.0"
implementation "com.linecorp:clova-extension-core:1.1.0"
//Optional
implementation "com.linecorp:clova-extension-converter-jackson:1.0.0" //the data convertor for jackson
implementation "com.linecorp:clova-extension-converter-jackson:1.1.0" //the data convertor for jackson
}
```

Expand Down
1 change: 1 addition & 0 deletions docs/clova-extension-converter-jackson/alltypes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
| Name | Summary |
|---|---|
| [com.linecorp.clova.extension.converter.jackson.JacksonObjectMapper](../com.linecorp.clova.extension.converter.jackson/-jackson-object-mapper/index.md) | The jackson implementation of [com.linecorp.clova.extension.client.ObjectMapper](#) |
| [com.linecorp.clova.extension.converter.jackson.serializer.audio.ProgressReportSerializer](../com.linecorp.clova.extension.converter.jackson.serializer.audio/-progress-report-serializer/index.md) | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-converter-jackson](../../index.md) / [com.linecorp.clova.extension.converter.jackson.serializer.audio](../index.md) / [ProgressReportSerializer](index.md) / [<init>](./-init-.md)

# <init>

`ProgressReportSerializer()`
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[clova-extension-converter-jackson](../../index.md) / [com.linecorp.clova.extension.converter.jackson.serializer.audio](../index.md) / [ProgressReportSerializer](./index.md)

# ProgressReportSerializer

`class ProgressReportSerializer : StdSerializer<ProgressReport>`

### Constructors

| Name | Summary |
|---|---|
| [&lt;init&gt;](-init-.md) | `ProgressReportSerializer()` |

### Functions

| Name | Summary |
|---|---|
| [serialize](serialize.md) | `fun serialize(value: ProgressReport, generator: JsonGenerator, provider: SerializerProvider): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-converter-jackson](../../index.md) / [com.linecorp.clova.extension.converter.jackson.serializer.audio](../index.md) / [ProgressReportSerializer](index.md) / [serialize](./serialize.md)

# serialize

`fun serialize(value: ProgressReport, generator: JsonGenerator, provider: SerializerProvider): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[clova-extension-converter-jackson](../index.md) / [com.linecorp.clova.extension.converter.jackson.serializer.audio](./index.md)

## Package com.linecorp.clova.extension.converter.jackson.serializer.audio

### Types

| Name | Summary |
|---|---|
| [ProgressReportSerializer](-progress-report-serializer/index.md) | `class ProgressReportSerializer : StdSerializer<ProgressReport>` |
1 change: 1 addition & 0 deletions docs/clova-extension-converter-jackson/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
| Name | Summary |
|---|---|
| [com.linecorp.clova.extension.converter.jackson](com.linecorp.clova.extension.converter.jackson/index.md) | |
| [com.linecorp.clova.extension.converter.jackson.serializer.audio](com.linecorp.clova.extension.converter.jackson.serializer.audio/index.md) | |

### Index

Expand Down
1 change: 1 addition & 0 deletions docs/clova-extension-converter-jackson/package-list
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ $dokka.format:gfm
$dokka.linkExtension:md

com.linecorp.clova.extension.converter.jackson
com.linecorp.clova.extension.converter.jackson.serializer.audio
21 changes: 18 additions & 3 deletions docs/clova-extension-core/alltypes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@
| Name | Summary |
|---|---|
| [com.linecorp.clova.extension.model.core.Application](../com.linecorp.clova.extension.model.core/-application/index.md) | |
| [com.linecorp.clova.extension.model.core.AudioPlayer](../com.linecorp.clova.extension.model.core/-audio-player/index.md) | |
| [com.linecorp.clova.extension.model.core.AudioStreamInfo](../com.linecorp.clova.extension.model.core/-audio-stream-info/index.md) | |
| [com.linecorp.clova.extension.model.audio.AudioItem](../com.linecorp.clova.extension.model.audio/-audio-item/index.md) | |
| [com.linecorp.clova.extension.model.payload.AudioPlayPayload](../com.linecorp.clova.extension.model.payload/-audio-play-payload/index.md) | The payload for AudioPlayer.Play directive Check [official document](https://clova-developers.line.me/guide/#/CEK/References/CEK_API.md#Play) for detail |
| [com.linecorp.clova.extension.model.audio.AudioPlayer](../com.linecorp.clova.extension.model.audio/-audio-player/index.md) | |
| [com.linecorp.clova.extension.model.audio.AudioSource](../com.linecorp.clova.extension.model.audio/-audio-source/index.md) | |
| [com.linecorp.clova.extension.model.audio.AudioStreamInfo](../com.linecorp.clova.extension.model.audio/-audio-stream-info/index.md) | |
| [com.linecorp.clova.extension.model.payload.AudioStreamPayload](../com.linecorp.clova.extension.model.payload/-audio-stream-payload/index.md) | |
| [com.linecorp.clova.extension.client.ClovaClient](../com.linecorp.clova.extension.client/-clova-client/index.md) | The ClovaClient provides the functionality for handling the requests from Clova platform, SDK also provides a DSL [(example)](../com.linecorp.clova.extension.client/clova-client.md) to create [ClovaClient](../com.linecorp.clova.extension.client/-clova-client/index.md) |
| [com.linecorp.clova.extension.model.response.ClovaExtensionResponse](../com.linecorp.clova.extension.model.response/-clova-extension-response/index.md) | The Clova extension response |
| [com.linecorp.clova.extension.model.request.ClovaRequest](../com.linecorp.clova.extension.model.request/-clova-request/index.md) | The basic type of clova request |
Expand All @@ -15,8 +19,15 @@
| [com.linecorp.clova.extension.model.request.CustomExtensionRequest](../com.linecorp.clova.extension.model.request/-custom-extension-request/index.md) | The custom extension request |
| [com.linecorp.clova.extension.model.request.CustomRequest](../com.linecorp.clova.extension.model.request/-custom-request/index.md) | |
| [com.linecorp.clova.extension.model.core.Device](../com.linecorp.clova.extension.model.core/-device/index.md) | |
| [com.linecorp.clova.extension.model.directive.Directive](../com.linecorp.clova.extension.model.directive/-directive/index.md) | |
| [com.linecorp.clova.extension.model.directive.DirectiveHeader](../com.linecorp.clova.extension.model.directive/-directive-header/index.md) | The header of directive |
| [com.linecorp.clova.extension.model.directive.DirectiveName](../com.linecorp.clova.extension.model.directive/-directive-name/index.md) | |
| [com.linecorp.clova.extension.model.directive.DirectiveNameSpace](../com.linecorp.clova.extension.model.directive/-directive-name-space/index.md) | |
| [com.linecorp.clova.extension.model.core.Display](../com.linecorp.clova.extension.model.core/-display/index.md) | |
| [com.linecorp.clova.extension.model.core.DisplaySize](../com.linecorp.clova.extension.model.core/-display-size/index.md) | |
| [com.linecorp.clova.extension.model.payload.EmptyPayload](../com.linecorp.clova.extension.model.payload/-empty-payload/index.md) | |
| [com.linecorp.clova.extension.model.request.event.Event](../com.linecorp.clova.extension.model.request.event/-event/index.md) | |
| [com.linecorp.clova.extension.model.request.EventRequest](../com.linecorp.clova.extension.model.request/-event-request/index.md) | The event request, which is used for audio application |
| [com.linecorp.clova.extension.exception.IllegalRequestException](../com.linecorp.clova.extension.exception/-illegal-request-exception/index.md) | Signals that the Clova responses are illegal. |
| [com.linecorp.clova.extension.model.request.Intent](../com.linecorp.clova.extension.model.request/-intent/index.md) | |
| [com.linecorp.clova.extension.model.request.IntentRequest](../com.linecorp.clova.extension.model.request/-intent-request/index.md) | |
Expand All @@ -26,7 +37,11 @@
| [com.linecorp.clova.extension.exception.NonsupportedRequestTypeException](../com.linecorp.clova.extension.exception/-nonsupported-request-type-exception/index.md) | Signals that the non-supported requests are received. |
| [com.linecorp.clova.extension.client.ObjectMapper](../com.linecorp.clova.extension.client/-object-mapper/index.md) | The generic interface for serialize/deserialize the object. To implement this interface to customize the object mapper. |
| [com.linecorp.clova.extension.model.core.Orientation](../com.linecorp.clova.extension.model.core/-orientation/index.md) | |
| [com.linecorp.clova.extension.model.core.PlayerActivity](../com.linecorp.clova.extension.model.core/-player-activity/index.md) | |
| [com.linecorp.clova.extension.model.payload.Payload](../com.linecorp.clova.extension.model.payload/-payload.md) | |
| [com.linecorp.clova.extension.model.audio.PlayBehavior](../com.linecorp.clova.extension.model.audio/-play-behavior/index.md) | |
| [com.linecorp.clova.extension.model.payload.PlayStatusPayload](../com.linecorp.clova.extension.model.payload/-play-status-payload/index.md) | |
| [com.linecorp.clova.extension.model.audio.PlayerActivity](../com.linecorp.clova.extension.model.audio/-player-activity/index.md) | |
| [com.linecorp.clova.extension.model.audio.ProgressReport](../com.linecorp.clova.extension.model.audio/-progress-report/index.md) | |
| [com.linecorp.clova.extension.client.RequestHandler](../com.linecorp.clova.extension.client/-request-handler.md) | The alias of request handler. It is suspend function with two parameters (T, Session) |
| [com.linecorp.clova.extension.model.request.RequestType](../com.linecorp.clova.extension.model.request/-request-type/index.md) | The type of clova custom request. Clova supports 3 types of requests now |
| [com.linecorp.clova.extension.client.RequestVerifier](../com.linecorp.clova.extension.client/-request-verifier/index.md) | The clova request verifier. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ SDK also provides a DSL [(example)](../clova-client.md) to create [ClovaClient](

| Name | Summary |
|---|---|
| [eventHandler](../event-handler.md) | `fun `[`ClovaClient`](./index.md)`.eventHandler(handler: `[`RequestHandler`](../-request-handler.md)`<`[`EventRequest`](../../com.linecorp.clova.extension.model.request/-event-request/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>The definition of DSL keyword sessionEndedHandler |
| [intentHandler](../intent-handler.md) | `fun `[`ClovaClient`](./index.md)`.intentHandler(handler: `[`RequestHandler`](../-request-handler.md)`<`[`IntentRequest`](../../com.linecorp.clova.extension.model.request/-intent-request/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>The definition of DSL keyword intentHandler |
| [launchHandler](../launch-handler.md) | `fun `[`ClovaClient`](./index.md)`.launchHandler(handler: `[`RequestHandler`](../-request-handler.md)`<`[`LaunchRequest`](../../com.linecorp.clova.extension.model.request/-launch-request/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>The definition of DSL keyword launchHandler |
| [sessionEndedHandler](../session-ended-handler.md) | `fun `[`ClovaClient`](./index.md)`.sessionEndedHandler(handler: `[`RequestHandler`](../-request-handler.md)`<`[`SessionEndedRequest`](../../com.linecorp.clova.extension.model.request/-session-ended-request/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>The definition of DSL keyword sessionEndedHandler |
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
[clova-extension-core](../index.md) / [com.linecorp.clova.extension.client](index.md) / [eventHandler](./event-handler.md)

# eventHandler

`@Dsl fun `[`ClovaClient`](-clova-client/index.md)`.eventHandler(handler: `[`RequestHandler`](-request-handler.md)`<`[`EventRequest`](../com.linecorp.clova.extension.model.request/-event-request/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)

The definition of DSL keyword sessionEndedHandler

### Parameters

`handler` - the user-defined session end handler
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
| Name | Summary |
|---|---|
| [clovaClient](clova-client.md) | `fun clovaClient(applicationId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, verifier: `[`RequestVerifier`](-request-verifier/index.md)` = RequestVerifierImpl(), init: `[`ClovaClient`](-clova-client/index.md)`.() -> `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`): `[`ClovaClient`](-clova-client/index.md)<br>The definition of DSL keyword clovaClient. |
| [eventHandler](event-handler.md) | `fun `[`ClovaClient`](-clova-client/index.md)`.eventHandler(handler: `[`RequestHandler`](-request-handler.md)`<`[`EventRequest`](../com.linecorp.clova.extension.model.request/-event-request/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>The definition of DSL keyword sessionEndedHandler |
| [intentHandler](intent-handler.md) | `fun `[`ClovaClient`](-clova-client/index.md)`.intentHandler(handler: `[`RequestHandler`](-request-handler.md)`<`[`IntentRequest`](../com.linecorp.clova.extension.model.request/-intent-request/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>The definition of DSL keyword intentHandler |
| [launchHandler](launch-handler.md) | `fun `[`ClovaClient`](-clova-client/index.md)`.launchHandler(handler: `[`RequestHandler`](-request-handler.md)`<`[`LaunchRequest`](../com.linecorp.clova.extension.model.request/-launch-request/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>The definition of DSL keyword launchHandler |
| [sessionEndedHandler](session-ended-handler.md) | `fun `[`ClovaClient`](-clova-client/index.md)`.sessionEndedHandler(handler: `[`RequestHandler`](-request-handler.md)`<`[`SessionEndedRequest`](../com.linecorp.clova.extension.model.request/-session-ended-request/index.md)`>): `[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)<br>The definition of DSL keyword sessionEndedHandler |
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioItem](index.md) / [&lt;init&gt;](./-init-.md)

# &lt;init&gt;

`AudioItem(audioItemId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, titleText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, artImageUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, headerText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, stream: `[`AudioStreamInfo`](../-audio-stream-info/index.md)`, titleSubText1: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, titleSubText2: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)`
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioItem](index.md) / [artImageUrl](./art-image-url.md)

# artImageUrl

`val artImageUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioItem](index.md) / [audioItemId](./audio-item-id.md)

# audioItemId

`val audioItemId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioItem](index.md) / [headerText](./header-text.md)

# headerText

`val headerText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioItem](./index.md)

# AudioItem

`data class AudioItem`

### Constructors

| Name | Summary |
|---|---|
| [&lt;init&gt;](-init-.md) | `AudioItem(audioItemId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, titleText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, artImageUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, headerText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null, stream: `[`AudioStreamInfo`](../-audio-stream-info/index.md)`, titleSubText1: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, titleSubText2: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null)` |

### Properties

| Name | Summary |
|---|---|
| [artImageUrl](art-image-url.md) | `val artImageUrl: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
| [audioItemId](audio-item-id.md) | `val audioItemId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
| [headerText](header-text.md) | `val headerText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
| [stream](stream.md) | `val stream: `[`AudioStreamInfo`](../-audio-stream-info/index.md) |
| [titleSubText1](title-sub-text1.md) | `val titleSubText1: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
| [titleSubText2](title-sub-text2.md) | `val titleSubText2: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?` |
| [titleText](title-text.md) | `val titleText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioItem](index.md) / [stream](./stream.md)

# stream

`val stream: `[`AudioStreamInfo`](../-audio-stream-info/index.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioItem](index.md) / [titleSubText1](./title-sub-text1.md)

# titleSubText1

`val titleSubText1: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioItem](index.md) / [titleSubText2](./title-sub-text2.md)

# titleSubText2

`val titleSubText2: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`?`
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioItem](index.md) / [titleText](./title-text.md)

# titleText

`val titleText: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioPlayer](index.md) / [&lt;init&gt;](./-init-.md)

# &lt;init&gt;

`AudioPlayer(activity: `[`PlayerActivity`](../-player-activity/index.md)`, offsetInMilliseconds: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, stream: `[`AudioStreamInfo`](../-audio-stream-info/index.md)`? = null, totalInMilliseconds: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null)`
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[clova-extension-core](../../index.md) / [com.linecorp.clova.extension.model.audio](../index.md) / [AudioPlayer](index.md) / [activity](./activity.md)

# activity

`val activity: `[`PlayerActivity`](../-player-activity/index.md)
Loading

0 comments on commit 59cef6d

Please sign in to comment.