Struct LauncherSocialMediaEntry

Namespace

Hi3Helper.Plugin.Core.Management.Api

Assembly

Hi3Helper.Plugin.Core.dll

Entry of the launcher's social media data.

public struct LauncherSocialMediaEntry : IDisposable

Implements

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

Mem.AsPointer<T>(scoped ref T)

Mem.CopyStructToUnmanaged<T>(scoped ref T)

Constructors

LauncherSocialMediaEntry()

Entry of the launcher's social media data.

public LauncherSocialMediaEntry()

Fields

Flags

Defines the kind of properties or flags that a social media entry can have.

public LauncherSocialMediaEntryFlag Flags

Field Value

LauncherSocialMediaEntryFlag

Properties

ChildEntryHandle

The handle of the child entry. The type is LauncherSocialMediaEntry

public readonly ref LauncherSocialMediaEntry ChildEntryHandle { get; }

Property Value

LauncherSocialMediaEntry

ClickUrl

Represent the click link/HREF string of this LauncherSocialMediaEntry instance.

public readonly string? ClickUrl { get; }

Property Value

string

Description

Represent the description string of this LauncherSocialMediaEntry instance.

public readonly string? Description { get; }

Property Value

string

IconHoverPath

Represent a path of the Hover Icon.
The format can be a Base64Url if IconHoverIsDataBuffer is defined
or a path/URL string if IconHoverIsPath is defined.

public readonly string? IconHoverPath { get; }

Property Value

string

IconPath

Represent a path of the Icon.
The format can be a Base64Url if IconIsDataBuffer is defined
or a path/URL string if IconIsPath is defined.

public readonly string? IconPath { get; }

Property Value

string

QrDescription

Represent the description string of the QR Image description.

public readonly string? QrDescription { get; }

Property Value

string

QrPath

Represent a path of the QR Image.
The format can be a Base64Url if QrImageIsDataBuffer is defined
or a path/URL string if QrImageIsPath is defined.

public readonly string? QrPath { get; }

Property Value

string

Methods

Dispose()

Dispose the handles of the icon, QR image, description, Click URL and its child handles.

public void Dispose()

WriteClickUrl(string?)

Write the click link/HREF of this entry.

public void WriteClickUrl(string? url)

Parameters

url string

The click link/HREF of this entry.

WriteClickUrl(Uri?)

Write the click link/HREF of this entry.

public void WriteClickUrl(Uri? url)

Parameters

url Uri

The click link/HREF of this entry.

WriteDescription(string?)

Write the description/name of this entry

public void WriteDescription(string? description)

Parameters

description string

The description/name of this entry.

WriteIcon(ReadOnlySpan<byte>)

Write IconPath as an embedded data in Base64Url format.

public void WriteIcon(ReadOnlySpan<byte> buffer)

Parameters

buffer ReadOnlySpan<byte>

The buffer of the data to be written from.

WriteIcon(string?)

Write IconPath as a path or URL.

public void WriteIcon(string? path)

Parameters

path string

The path/URL to write.

WriteIconHover(ReadOnlySpan<byte>)

Write IconHoverPath as an embedded data in Base64Url format.

public void WriteIconHover(ReadOnlySpan<byte> buffer)

Parameters

buffer ReadOnlySpan<byte>

The buffer of the data to be written from.

WriteIconHover(string?)

Write IconHoverPath as a path or URL.

public void WriteIconHover(string? path)

Parameters

path string

The path/URL to write.

WriteQrImage(ReadOnlySpan<byte>)

Write QrPath as an embedded data in Base64Url format.

public void WriteQrImage(ReadOnlySpan<byte> buffer)

Parameters

buffer ReadOnlySpan<byte>

The buffer of the data to be written from.

WriteQrImage(string?)

Write QrPath as a path or URL.

public void WriteQrImage(string? path)

Parameters

path string

The path/URL to write.

WriteQrImageDescription(string?)

Write the description/name of the QR Image

public void WriteQrImageDescription(string? description)

Parameters

description string

The description/name of the QR Image.