Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SdkIndexLinkClientPlugin

Hierarchy

  • RendererComponent
    • SdkIndexLinkClientPlugin

Implements

  • ComponentHost

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly clientDocs

clientDocs: string

The path pattern denotes the location of individual service client doc. "{{CLIENT}}" will be replaced with the client name. For example: path/{{CLIENT}}/docs will target s3 docs at path/client-s3/docs

componentName

componentName: string

Readonly out

out: string

Accessors

application

  • get application(): Application

owner

  • get owner(): Renderer

Methods

Protected bubble

  • bubble(name: Event | EventMap | string, ...args: any[]): this

  • Parameters

    • name: Event | EventMap | string
    • Rest ...args: any[]

    Returns this

getOptionDeclarations

  • getOptionDeclarations(): DeclarationOption[]

Private groupNavigation

  • groupNavigation(navigation: NavigationItem): NavigationItem

initialize

  • initialize(): void

Private isClient

  • isClient(item: NavigationItem): boolean

Private isGrouped

  • isGrouped(navigation: NavigationItem): boolean

listenTo

  • listenTo(obj: EventDispatcher, name: EventMap | string, callback?: EventCallback, priority?: number): this

  • Parameters

    • obj: EventDispatcher
    • name: EventMap | string
    • Optional callback: EventCallback
    • Optional priority: number

    Returns this

listenToOnce

  • listenToOnce(obj: EventDispatcher, eventMap: EventMap): any
  • listenToOnce(obj: EventDispatcher, name: string, callback: EventCallback, priority?: number): any

  • Parameters

    • obj: EventDispatcher
    • eventMap: EventMap

    Returns any

  • Parameters

    • obj: EventDispatcher
    • name: string
    • callback: EventCallback
    • Optional priority: number

    Returns any

off

  • off(): any
  • off(eventMap: EventMap | undefined, context?: any): any
  • off(name: string | undefined, callback?: EventCallback, context?: any): any

  • Returns any

  • Parameters

    • eventMap: EventMap | undefined
    • Optional context: any

    Returns any

  • Parameters

    • name: string | undefined
    • Optional callback: EventCallback
    • Optional context: any

    Returns any

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: number): any

  • Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • eventMap: EventMap
    • Optional callback: EventCallback
    • Optional context: any
    • Optional priority: number

    Returns any

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: number

    Returns any

onPageBegin

  • onPageBegin(page: PageEvent): void

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any

  • Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns any

stopListening

  • stopListening(obj?: EventDispatcher, name?: EventMap | string, callback?: EventCallback): this

  • Parameters

    • Optional obj: EventDispatcher
    • Optional name: EventMap | string
    • Optional callback: EventCallback

    Returns this

trigger

  • trigger(name: Event | EventMap | string, ...args: any[]): this

  • Parameters

    • name: Event | EventMap | string
    • Rest ...args: any[]

    Returns this