Class KodiIntrospect

Wrapper class for Kodi's JSONRPC.Introspect metadata response.

Hierarchy

KodiIntrospect

Implements

JsonRpcResponse

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new KodiIntrospect(introspect: KodiIntrospect): KodiIntrospect

- Defined in lib/KodiIntrospect.ts:5
Parameters
- introspect: KodiIntrospect
Returns KodiIntrospect

Properties

Optional id

id: string | number

jsonrpc

jsonrpc: "2.0"

result

result: ServiceDescription

Private Optional validator

validator: Validator

Methods

Optional describeMethod

describeMethod(method: string): MethodDescription

- Defined in lib/KodiIntrospect.ts:24
Method to return a method descripton.

Parameters
- method: string
Returns MethodDescription

Optional describeNotification

describeNotification(notification: string): NotificationDescription

- Defined in lib/KodiIntrospect.ts:29
Method to return a notification description.

Parameters
- notification: string
Returns NotificationDescription

Optional describeType

describeType(typeName: string): JsonSchema

- Defined in lib/KodiIntrospect.ts:34
Method to return a type description.

Parameters
- typeName: string
Returns JsonSchema

Optional listMethods

listMethods(): string[]
listMethods(group: false): string[]
listMethods(group: true): Record<string, string[]>
listMethods(group: boolean): string[] | Record<string, string[]>

- Defined in lib/KodiIntrospect.ts:50
Method to list Kodi JSON-RPC methods.

Returns string[]
- Defined in lib/KodiIntrospect.ts:51
Parameters
- group: false
Returns string[]
- Defined in lib/KodiIntrospect.ts:52
Parameters
- group: true
Returns Record<string, string[]>
- Defined in lib/KodiIntrospect.ts:53
Parameters
- group: boolean
Returns string[] | Record<string, string[]>

Optional validateSchema

validateSchema(input: any, schema: JsonSchema, throwError?: boolean): boolean

- Defined in lib/KodiIntrospect.ts:39
Method to validate an input by it's accompanying schema.

Parameters
- input: any
- schema: JsonSchema
- Optional throwError: boolean
Returns boolean

Optional version

version(): string

- Defined in lib/KodiIntrospect.ts:75
Get the version of the Kodi API.

Returns string

Generated using TypeDoc