Interface ILauncherApiNews

Namespace

Hi3Helper.Plugin.Core.Management.Api

Assembly

Hi3Helper.Plugin.Core.dll

Defines the contract for managing launcher news feed, such as social media details, carousel images, and news entries.

[GeneratedComInterface]
[Guid("436f6c6c-6170-7365-727f-000000000022")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[IUnknownDerived<InterfaceInformation, InterfaceImplementation>]
public interface ILauncherApiNews : ILauncherApi, IInitializableTask, IFree

Remarks

This interface inherits from IInitializableTask, requiring implementers to provide asynchronous initialization logic.

Methods

DownloadAssetAsync(LauncherPathEntry, FileHandle, FileReadProgressDelegate, in Guid, out nint)

void DownloadAssetAsync(LauncherPathEntry entry, FileHandle outputStreamHandle, PluginFiles.FileReadProgressDelegate downloadProgress, in Guid cancelToken, out nint result)

Parameters

entry LauncherPathEntry

outputStreamHandle FileHandle

downloadProgress PluginFiles.FileReadProgressDelegate

cancelToken Guid

result nint

DownloadAssetAsync(string, FileHandle, FileReadProgressDelegate, in Guid, out nint)

void DownloadAssetAsync(string fileUrl, FileHandle outputStreamHandle, PluginFiles.FileReadProgressDelegate downloadProgress, in Guid cancelToken, out nint result)

Parameters

fileUrl string

outputStreamHandle FileHandle

downloadProgress PluginFiles.FileReadProgressDelegate

cancelToken Guid

result nint

Free()

void Free()

GetCarouselEntries(out nint, out int, out bool, out bool)

Get the carousel image entries for the launcher.
This method returns a handle to the PluginDisposableMemory<T> of LauncherCarouselEntry.
Pass this method to ToManagedSpan<T>(MarshalToMemorySelectorDelegate) to get the span.

void GetCarouselEntries(out nint handle, out int count, out bool isDisposable, out bool isAllocated)

Parameters

handle nint

The handle to the pointer of the LauncherCarouselEntry data

count int

How much data of LauncherCarouselEntry inside of the handle

isDisposable bool

Whether the handle is disposable

isAllocated bool

true if it's not empty. Otherwise, false

GetNewsEntries(out nint, out int, out bool, out bool)

Get the news entries fot the launcher.
This method returns a handle to the PluginDisposableMemory<T> of LauncherNewsEntry.
Pass this method to ToManagedSpan<T>(MarshalToMemorySelectorDelegate) to get the span.

void GetNewsEntries(out nint handle, out int count, out bool isDisposable, out bool isAllocated)

Parameters

handle nint

The handle to the pointer of the LauncherNewsEntry data

count int

How much data of LauncherNewsEntry inside of the handle

isDisposable bool

Whether the handle is disposable

isAllocated bool

true if it's not empty. Otherwise, false

GetSocialMediaEntries(out nint, out int, out bool, out bool)

Get the social media info entries for the launcher.
This method returns a handle to the PluginDisposableMemory<T> of LauncherSocialMediaEntry.
Pass this method to ToManagedSpan<T>(MarshalToMemorySelectorDelegate) to get the span.

void GetSocialMediaEntries(out nint handle, out int count, out bool isDisposable, out bool isAllocated)

Parameters

handle nint

The handle to the pointer of the LauncherSocialMediaEntry data

count int

How much data of LauncherSocialMediaEntry inside of the handle

isDisposable bool

Whether the handle is disposable

isAllocated bool

true if it's not empty. Otherwise, false

InitAsync(in Guid, out nint)

void InitAsync(in Guid cancelToken, out nint result)

Parameters

cancelToken Guid

result nint