Lynx
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

LynxLoadMeta

LynxLoadMeta is the metadata structure used by LynxView to load templates. It will be used as the input parameter of loadTemplate. Users can use LynxLoadMeta to specify many parameters of loading templates, such as specifying template content, template initial data, and other additional configuration information;

Android:

Field

  • url: String : Template file path;
  • binaryData: byte[]: The binary file data of the template;
  • bundle: TemplateBundle: TemplateBundle object parsed in advance by the template's binary file data;
  • initialData: TemplateData: Initial data specified by the client during the first screen loading process;
  • globalProps: TemplateData: Global properties, which will be synchronized to the template after the template is loaded.
  • loadMode: LynxLoadMode: Loading mode, the default value is LynxLoadMode.NORMAL.
  • loadOptions: EnumSet<LynxLoadOption>: Additional configuration information when loading templates;
  • lynxViewConfig: Map<String, String>: Page Config information passed in when loading the template.
INFO

url, binaryData, bundle are the required parameters for template loading. You can pass only one or all of them. The priority relationship is as follows: bundle > binaryData > url

INFO

loadOptions is additional configuration information when loading a template. Currently the following configuration items are supported:

  • RECYCLE_TEMPLATE_BUNDLE: After LynxView uses url or binaryData to load the template, it supports returning a TemplateBundle to the calling business party through LynxViewClient;
  • DUMP_ELEMENT: When LynxView loads a Bundle, copy the ElementBundle to the TemplateBundle and pass it back through the LynxViewClient;
INFO

loadMode is the loading mode of the template. Currently, the following configuration items are supported:

  • NORMAL: Default loading mode.
  • PRE_PAINTING: Suspend JS events when loading the template. Events will be sent during update, and layout will be blocked until the update is complete.
  • PRE_PAINTING_DRAW: Suspend JS events when loading the template. Events will be sent during update.

Construction

To construct a LynxLoadMeta object on the Android platform, you need to use LynxLoadMeta.Builder:

LynxLoadMeta.Builder builder = new LynxLoadMeta.Builder();
builder.setUrl();
builder.setBinaryData();
builder.setTemplateBundle();
builder.setInitialData();
builder.setGlobalProps();
builder.setLoadMode();
builder.addLoadOption();
builder.setLynxViewConfig();
LynxLoadMeta meta = builder.build();

iOS

Field

  • url: NSString*: Template file path;
  • binaryData: NSData*: The binary file data of the template;
  • templateBundle: LynxTemplateBundle*: TemplateBundle object parsed in advance by the template's binary file data;
  • initialData: LynxTemplateData*: Initial data specified by the client during the first screen loading process;
  • globalProps: LynxTemplateData*: Global properties, which will be synchronized to the template after the template is loaded.
  • loadMode: LynxLoadMode: Loading mode, the default value is LynxLoadModeNormal.
  • loadOption: LynxLoadOption: Additional configuration information when loading templates;
  • lynxViewConfig: NSMutableDictionary<NSString*, id>*: Page Config information passed in when loading the template.
INFO

url, binaryData, templateBundle are the required parameters for template loading. You can pass only one or all of them. The priority relationship is as follows: templateBundle > binaryData > url

INFO

loadOption is additional configuration information when loading a template. Currently the following configuration items are supported:

  • RECYCLE_TEMPLATE_BUNDLE: After LynxView uses url or binaryData to load the template, it supports returning a TemplateBundle to the calling business party through LynxViewClient;
  • DUMP_ELEMENT: When LynxView loads a Bundle , copy the ElementBundle to the TemplateBundle and pass it back through the LynxViewClient;
INFO

loadMode is the loading mode of the template. Currently, the following configuration items are supported:

  • LynxLoadModeNormal: Default loading mode.
  • LynxLoadModePrePainting: Suspend JS events when loading the template. Events will be sent during update, and layout will be blocked until the update is complete.

Construction

On the iOS platform, you can construct a LynxLoadMeta object as follows:

LynxLoadMeta* meta = [LynxLoadMeta init];
meta.url = @"";
meta.binaryData = nil;
meta.templateBundle = nil;
meta.initialData = nil;
meta.globalProps = nil;
meta.loadMode = LynxLoadModeNormal;
meta.loadOption = LynxLoadOptionDumpElement | LynxLoadOptionRecycleTemplateBundle;
meta.lynxViewConfig = nil;

Compatibility

LCD tables only load in the browser

Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.