pub struct DocApiHyperlinks<'a, I: Invoker> { /* private fields */ }Implementations§
Source§impl<'a, I: Invoker> DocApiHyperlinks<'a, I>
impl<'a, I: Invoker> DocApiHyperlinks<'a, I>
pub fn new(invoker: &'a I) -> Self
Sourcepub fn get<'call>(
&'call self,
params: &'call DocHyperlinksGetBoundParams,
) -> impl Future<Output = Result<DocHyperlinksGetResult>> + Send + 'call
pub fn get<'call>( &'call self, params: &'call DocHyperlinksGetBoundParams, ) -> impl Future<Output = Result<DocHyperlinksGetResult>> + Send + 'call
Retrieve details of a specific hyperlink by its inline address.
Sourcepub async fn get_with_options(
&self,
params: &DocHyperlinksGetBoundParams,
options: InvokeOptions,
) -> Result<DocHyperlinksGetResult>
pub async fn get_with_options( &self, params: &DocHyperlinksGetBoundParams, options: InvokeOptions, ) -> Result<DocHyperlinksGetResult>
Retrieve details of a specific hyperlink by its inline address.
Sourcepub fn insert<'call>(
&'call self,
params: &'call DocHyperlinksInsertBoundParams,
) -> impl Future<Output = Result<DocHyperlinksInsertResult>> + Send + 'call
pub fn insert<'call>( &'call self, params: &'call DocHyperlinksInsertBoundParams, ) -> impl Future<Output = Result<DocHyperlinksInsertResult>> + Send + 'call
Insert new linked text at a target position.
Sourcepub async fn insert_with_options(
&self,
params: &DocHyperlinksInsertBoundParams,
options: InvokeOptions,
) -> Result<DocHyperlinksInsertResult>
pub async fn insert_with_options( &self, params: &DocHyperlinksInsertBoundParams, options: InvokeOptions, ) -> Result<DocHyperlinksInsertResult>
Insert new linked text at a target position.
Sourcepub fn list<'call>(
&'call self,
params: &'call DocHyperlinksListBoundParams,
) -> impl Future<Output = Result<DocHyperlinksListResult>> + Send + 'call
pub fn list<'call>( &'call self, params: &'call DocHyperlinksListBoundParams, ) -> impl Future<Output = Result<DocHyperlinksListResult>> + Send + 'call
List the hyperlinks of one story, with optional filtering by href, anchor, or display text. The body is listed by default; pass in with a footnote or endnote story to list that note.
Sourcepub async fn list_with_options(
&self,
params: &DocHyperlinksListBoundParams,
options: InvokeOptions,
) -> Result<DocHyperlinksListResult>
pub async fn list_with_options( &self, params: &DocHyperlinksListBoundParams, options: InvokeOptions, ) -> Result<DocHyperlinksListResult>
List the hyperlinks of one story, with optional filtering by href, anchor, or display text. The body is listed by default; pass in with a footnote or endnote story to list that note.
Sourcepub fn patch<'call>(
&'call self,
params: &'call DocHyperlinksPatchBoundParams,
) -> impl Future<Output = Result<DocHyperlinksPatchResult>> + Send + 'call
pub fn patch<'call>( &'call self, params: &'call DocHyperlinksPatchBoundParams, ) -> impl Future<Output = Result<DocHyperlinksPatchResult>> + Send + 'call
Update hyperlink metadata (destination, tooltip, target, rel) without changing display text.
Sourcepub async fn patch_with_options(
&self,
params: &DocHyperlinksPatchBoundParams,
options: InvokeOptions,
) -> Result<DocHyperlinksPatchResult>
pub async fn patch_with_options( &self, params: &DocHyperlinksPatchBoundParams, options: InvokeOptions, ) -> Result<DocHyperlinksPatchResult>
Update hyperlink metadata (destination, tooltip, target, rel) without changing display text.
Sourcepub fn remove<'call>(
&'call self,
params: &'call DocHyperlinksRemoveBoundParams,
) -> impl Future<Output = Result<DocHyperlinksRemoveResult>> + Send + 'call
pub fn remove<'call>( &'call self, params: &'call DocHyperlinksRemoveBoundParams, ) -> impl Future<Output = Result<DocHyperlinksRemoveResult>> + Send + 'call
Remove a hyperlink. Mode ‘unwrap’ preserves display text; ‘deleteText’ removes the linked content entirely.
Sourcepub async fn remove_with_options(
&self,
params: &DocHyperlinksRemoveBoundParams,
options: InvokeOptions,
) -> Result<DocHyperlinksRemoveResult>
pub async fn remove_with_options( &self, params: &DocHyperlinksRemoveBoundParams, options: InvokeOptions, ) -> Result<DocHyperlinksRemoveResult>
Remove a hyperlink. Mode ‘unwrap’ preserves display text; ‘deleteText’ removes the linked content entirely.
Sourcepub fn wrap<'call>(
&'call self,
params: &'call DocHyperlinksWrapBoundParams,
) -> impl Future<Output = Result<DocHyperlinksWrapResult>> + Send + 'call
pub fn wrap<'call>( &'call self, params: &'call DocHyperlinksWrapBoundParams, ) -> impl Future<Output = Result<DocHyperlinksWrapResult>> + Send + 'call
Wrap an existing text range with a hyperlink. A range inside one pending tracked insertion is linked without authoring a revision: the insertion keeps its author and date and is split at the range boundaries. Ranges that cross a revision boundary or touch deleted, moved or several revisions are refused.
Sourcepub async fn wrap_with_options(
&self,
params: &DocHyperlinksWrapBoundParams,
options: InvokeOptions,
) -> Result<DocHyperlinksWrapResult>
pub async fn wrap_with_options( &self, params: &DocHyperlinksWrapBoundParams, options: InvokeOptions, ) -> Result<DocHyperlinksWrapResult>
Wrap an existing text range with a hyperlink. A range inside one pending tracked insertion is linked without authoring a revision: the insertion keeps its author and date and is split at the range boundaries. Ranges that cross a revision boundary or touch deleted, moved or several revisions are refused.