Skip to main content

ArkWeb_WebMessagePortAPI

Struct ArkWeb_WebMessagePortAPI 

Source
#[repr(C)]
pub struct ArkWeb_WebMessagePortAPI { pub size: usize, pub postMessage: Option<unsafe extern "C" fn(webMessagePort: ArkWeb_WebMessagePortPtr, webTag: *const c_char, webMessage: ArkWeb_WebMessagePtr) -> ArkWeb_ErrorCode>, pub close: Option<unsafe extern "C" fn(webMessagePort: ArkWeb_WebMessagePortPtr, webTag: *const c_char)>, pub setMessageEventHandler: Option<unsafe extern "C" fn(webMessagePort: ArkWeb_WebMessagePortPtr, webTag: *const c_char, messageEventHandler: ArkWeb_OnMessageEventHandler, userData: *mut c_void)>, }
Expand description

@brief Defines the web message API for native ArkWeb. Before invoking an API, you are advised to use ARKWEB_MEMBER_MISSING to check whether the function structure has a corresponding function pointer to avoid crash caused by mismatch between the SDK and the device ROM. Use OH_ArkWeb_GetNativeAPI in the UI thread to obtain the WebMessagePort-related interface cluster.

@since 12

Fields§

§size: usize

The ArkWeb_WebMessagePortAPI struct size.

§postMessage: Option<unsafe extern "C" fn(webMessagePort: ArkWeb_WebMessagePortPtr, webTag: *const c_char, webMessage: ArkWeb_WebMessagePtr) -> ArkWeb_ErrorCode>

@brief Post message to HTML.

@param webMessagePort The ArkWeb_WebMessagePort. @param webTag The name of the web component. @param webMessage The ArkWeb_WebMessage to send. @return Post message result code. {@link ARKWEB_SUCCESS} post message success. {@link ARKWEB_INVALID_PARAM} the parameter verification fails. {@link ARKWEB_INIT_ERROR} no web associated with this webTag.

§close: Option<unsafe extern "C" fn(webMessagePort: ArkWeb_WebMessagePortPtr, webTag: *const c_char)>

@brief Close the message port.

@param webMessagePort The ArkWeb_WebMessagePort. @param webTag The name of the web component.

§setMessageEventHandler: Option<unsafe extern "C" fn(webMessagePort: ArkWeb_WebMessagePortPtr, webTag: *const c_char, messageEventHandler: ArkWeb_OnMessageEventHandler, userData: *mut c_void)>

@brief Set a callback to receive message from HTML.

@param webMessagePort The ArkWeb_WebMessagePort. @param webTag The name of the web component. @param messageEventHandler The handler to receive message from HTML. @param userData The data set by user.

Trait Implementations§

Source§

impl Clone for ArkWeb_WebMessagePortAPI

Source§

fn clone(&self) -> ArkWeb_WebMessagePortAPI

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ArkWeb_WebMessagePortAPI

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Copy for ArkWeb_WebMessagePortAPI

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.