Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SerializedStateManagerV1

Index

Methods

getSerializedState

  • getSerializedState(): string | undefined
  • This method is intended to be called by consumers, i.e. Feature Apps and Feature Services, on the client to retrieve the serialized state that was created on the server.

    Returns string | undefined

register

  • register(serializeState: function): void
  • This method is intended to be called by consumers, i.e. Feature Apps and Feature Services, on the server to register a callback that serializes their state.

    Parameters

    • serializeState: function

      A callback that returns the consumer state as a serialized string.

        • (): string
        • Returns string

    Returns void

serializeStates

  • serializeStates(): string
  • This method is intended to be called by the integrator on the server when the server-side rendering has been completed, to serialize all consumer states. The returned string is encoded, so that it can be safely injected into an HTML document. On the client, this string must be passed unmodified into setSerializedStates where it will be decoded again.

    Returns string

setSerializedStates

  • setSerializedStates(serializedStates: string): void
  • This method is intended to be called by the integrator on the client to provide the serialized state to all consumers, i.e. Feature Apps and Feature Services, (via getSerializedState) that serialized their state on the server.

    Parameters

    • serializedStates: string

      The string that was created on the server with serializeStates.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc