Skip to main content

LaunchCategoryOptions

type LaunchCategoryOptions = {
  additionalData?: any;
  criteria?: FilterOption;
  evaluatorOptions?: EvaluatorOptions;
  excludeEVPProviders?: boolean;
  redirectParams: {
     targetName: string;
     targetParams?: Record<string, string>;
     targetType: NavigationType;
  };
  serviceOrderId?: string;
  settings?: any;
  source: string;
  transactionId?: string;
};

options to launch service order integration by category

Properties​

additionalData?​

optional additionalData?: any;

additional data needed for the service order integration

criteria?​

optional criteria?: FilterOption;

filter criteria to narrow down available service options

evaluatorOptions?​

optional evaluatorOptions?: EvaluatorOptions;

options to configure the evaluator api for service eligibility

excludeEVPProviders?​

optional excludeEVPProviders?: boolean;

flag to exclude EVP providers from the service orders

redirectParams​

redirectParams: {
  targetName: string;
  targetParams?: Record<string, string>;
  targetType: NavigationType;
};

location to redirect to after the service order integration flow is complete.

NameTypeDescription
targetNamestringname of redirect location Example Services, Secondary Registration etc.,
targetParams?Record<string, string>additional query parameters to be passed to the redirect location. For example, if rediret requested to services area with targetParams { 'key1': 'value1', 'key2': 'value2'}, the url will have querystring as services?query={'transactionId':123, 'orderId':456, 'key1': 'value1', 'key2': 'value2'}
targetTypeNavigationTypetype of redirect location Example NavigationType.STANDARD_FORM

serviceOrderId?​

optional serviceOrderId?: string;

unique id of the existing service order

settings?​

optional settings?: any;

settings to be passed to the service order integration

source​

source: string;

source application context that is launching the service order integration urn patterned string example: urn:elli:services:getpricing

transactionId?​

optional transactionId?: string;

unique id of the existing service order transaction