pub struct DocApiComments<'a, I: Invoker> { /* private fields */ }Implementations§
Source§impl<'a, I: Invoker> DocApiComments<'a, I>
impl<'a, I: Invoker> DocApiComments<'a, I>
pub fn new(invoker: &'a I) -> Self
Sourcepub fn create<'call>(
&'call self,
params: &'call DocCommentsCreateBoundParams,
) -> impl Future<Output = Result<DocCommentsCreateResult>> + Send + 'call
pub fn create<'call>( &'call self, params: &'call DocCommentsCreateBoundParams, ) -> impl Future<Output = Result<DocCommentsCreateResult>> + Send + 'call
Create a new comment thread (or reply when parentCommentId is given). Accepts TextAddress / TextTarget anchors, or a TrackedChangeCommentTarget that names a logical tracked-change id. The tracked-change target accepts both the explicit kind form and the Labs-compatible trackedChangeId-only form; the adapter normalizes it to a Word-compatible content anchor on the requested revision side. Callers may supply a durable externalId, or use the v1-compatible caller-supplied commentId alias, plus author fields and arbitrary JSON metadata for integration correlation. The caller-owned id remains distinct from the generated Word-compatible commentId.
Sourcepub async fn create_with_options(
&self,
params: &DocCommentsCreateBoundParams,
options: InvokeOptions,
) -> Result<DocCommentsCreateResult>
pub async fn create_with_options( &self, params: &DocCommentsCreateBoundParams, options: InvokeOptions, ) -> Result<DocCommentsCreateResult>
Create a new comment thread (or reply when parentCommentId is given). Accepts TextAddress / TextTarget anchors, or a TrackedChangeCommentTarget that names a logical tracked-change id. The tracked-change target accepts both the explicit kind form and the Labs-compatible trackedChangeId-only form; the adapter normalizes it to a Word-compatible content anchor on the requested revision side. Callers may supply a durable externalId, or use the v1-compatible caller-supplied commentId alias, plus author fields and arbitrary JSON metadata for integration correlation. The caller-owned id remains distinct from the generated Word-compatible commentId.
Sourcepub fn delete<'call>(
&'call self,
params: &'call DocCommentsDeleteBoundParams,
) -> impl Future<Output = Result<DocCommentsDeleteResult>> + Send + 'call
pub fn delete<'call>( &'call self, params: &'call DocCommentsDeleteBoundParams, ) -> impl Future<Output = Result<DocCommentsDeleteResult>> + Send + 'call
Remove the targeted comment or reply by ID. Deleting a root does not delete descendant replies.
Sourcepub async fn delete_with_options(
&self,
params: &DocCommentsDeleteBoundParams,
options: InvokeOptions,
) -> Result<DocCommentsDeleteResult>
pub async fn delete_with_options( &self, params: &DocCommentsDeleteBoundParams, options: InvokeOptions, ) -> Result<DocCommentsDeleteResult>
Remove the targeted comment or reply by ID. Deleting a root does not delete descendant replies.
Sourcepub fn get<'call>(
&'call self,
params: &'call DocCommentsGetBoundParams,
) -> impl Future<Output = Result<DocCommentsGetResult>> + Send + 'call
pub fn get<'call>( &'call self, params: &'call DocCommentsGetBoundParams, ) -> impl Future<Output = Result<DocCommentsGetResult>> + Send + 'call
Retrieve a single comment thread by ID.
Sourcepub async fn get_with_options(
&self,
params: &DocCommentsGetBoundParams,
options: InvokeOptions,
) -> Result<DocCommentsGetResult>
pub async fn get_with_options( &self, params: &DocCommentsGetBoundParams, options: InvokeOptions, ) -> Result<DocCommentsGetResult>
Retrieve a single comment thread by ID.
Sourcepub fn list<'call>(
&'call self,
params: &'call DocCommentsListBoundParams,
) -> impl Future<Output = Result<DocCommentsListResult>> + Send + 'call
pub fn list<'call>( &'call self, params: &'call DocCommentsListBoundParams, ) -> impl Future<Output = Result<DocCommentsListResult>> + Send + 'call
List all comment threads in the document.
Sourcepub async fn list_with_options(
&self,
params: &DocCommentsListBoundParams,
options: InvokeOptions,
) -> Result<DocCommentsListResult>
pub async fn list_with_options( &self, params: &DocCommentsListBoundParams, options: InvokeOptions, ) -> Result<DocCommentsListResult>
List all comment threads in the document.
Sourcepub fn patch<'call>(
&'call self,
params: &'call DocCommentsPatchBoundParams,
) -> impl Future<Output = Result<DocCommentsPatchResult>> + Send + 'call
pub fn patch<'call>( &'call self, params: &'call DocCommentsPatchBoundParams, ) -> impl Future<Output = Result<DocCommentsPatchResult>> + Send + 'call
Patch exactly one field on an existing comment (text, target, status, or isInternal). The target branch accepts a plain TextAddress or a TrackedChangeCommentTarget, with or without kind: "trackedChange", that names a logical tracked-change id. The legacy isInternal input sets or clears the sdcom:internal attribute for v1 backward compatibility. Multi-field patches and no-op edits are rejected with INVALID_INPUT; reply target / status patches are rejected with INVALID_CONTEXT.
Sourcepub async fn patch_with_options(
&self,
params: &DocCommentsPatchBoundParams,
options: InvokeOptions,
) -> Result<DocCommentsPatchResult>
pub async fn patch_with_options( &self, params: &DocCommentsPatchBoundParams, options: InvokeOptions, ) -> Result<DocCommentsPatchResult>
Patch exactly one field on an existing comment (text, target, status, or isInternal). The target branch accepts a plain TextAddress or a TrackedChangeCommentTarget, with or without kind: "trackedChange", that names a logical tracked-change id. The legacy isInternal input sets or clears the sdcom:internal attribute for v1 backward compatibility. Multi-field patches and no-op edits are rejected with INVALID_INPUT; reply target / status patches are rejected with INVALID_CONTEXT.