
public final class AIToolCallPart

A tool the agent called, run by the agent's backend or by a person's device.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`AIToolCallPart.Status`	Where a tool call is. An open set: compare against the statuses you know, and treat the rest as still in progress.
`public final class`	`AIToolCallPart.Executor`	Who runs a tool. An open set: compare against the executors you know.

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`isDeclined`
`private final Double`	`durationSeconds`
`private final String`	`id`
`private final String`	`name`
`private final String`	`displayTitle`
`private final AIToolCallPart.Status`	`status`
`private final AIToolCallPart.Executor`	`executor`
`private final String`	`targetUserId`
`private final String`	`targetClientId`
`private final String`	`arguments`
`private final String`	`summary`
`private final Integer`	`durationMs`
`private final AIToolApproval`	`approval`

Constructor Summary

Constructors
Constructor	Description
`AIToolCallPart(String id, String name, String displayTitle, AIToolCallPart.Status status, AIToolCallPart.Executor executor, String targetUserId, String targetClientId, String arguments, String summary, Integer durationMs, AIToolApproval approval)`

Method Summary

Modifier and Type	Method	Description
`final Boolean`	`getIsDeclined()`
`final Double`	`getDurationSeconds()`
`final String`	`getId()`
`final String`	`getName()`
`final String`	`getDisplayTitle()`
`final AIToolCallPart.Status`	`getStatus()`
`final AIToolCallPart.Executor`	`getExecutor()`
`final String`	`getTargetUserId()`
`final String`	`getTargetClientId()`
`final String`	`getArguments()`
`final String`	`getSummary()`
`final Integer`	`getDurationMs()`
`final AIToolApproval`	`getApproval()`
`final Boolean`	`isAwaiting(String userId, String clientId)`	Whether this call is waiting for this device: a client tool, still awaiting its result, targeted at this person and this install.
`final Boolean`	`isAwaitingApproval(String userId, String clientId)`	Whether this call is waiting for this person to allow it, on this device: still awaiting approval, targeted at this person, and at this install when it names one (a client tool does; a server tool's question may be answered from any of their devices).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AIToolCallPart
```
AIToolCallPart(String id, String name, String displayTitle, AIToolCallPart.Status status, AIToolCallPart.Executor executor, String targetUserId, String targetClientId, String arguments, String summary, Integer durationMs, AIToolApproval approval)
```
    Parameters:
    
    id - The model provider's tool-call ID.
    
    name - The tool's name, as the agent declared it.
    
    displayTitle - What the call is doing, in words for people, such as "Checking your location".
    
    status - Where the call is.
    
    executor - Who runs the tool.
    
    targetUserId - The person whose device must run a client tool.
    
    targetClientId - The install that must run a client tool, from the custom data of the person's triggering message.
    
    arguments - The call's arguments as JSON text with sorted keys, present for client tools, which need them to run.
    
    summary - A short, shareable outcome, such as "Found your location".
    
    durationMs - How long the call took, in milliseconds.
    
    approval - What the call asks the person it waits for before it runs, and how they answered, when its tool asks first.
- Method Detail
  - getIsDeclined
```
 final Boolean getIsDeclined()
```
  - getDurationSeconds
```
 final Double getDurationSeconds()
```
  - getId
```
 final String getId()
```
  - getName
```
 final String getName()
```
  - getDisplayTitle
```
 final String getDisplayTitle()
```
  - getStatus
```
 final AIToolCallPart.Status getStatus()
```
  - getExecutor
```
 final AIToolCallPart.Executor getExecutor()
```
  - getTargetUserId
```
 final String getTargetUserId()
```
  - getTargetClientId
```
 final String getTargetClientId()
```
  - getArguments
```
 final String getArguments()
```
  - getSummary
```
 final String getSummary()
```
  - getDurationMs
```
 final Integer getDurationMs()
```
  - getApproval
```
 final AIToolApproval getApproval()
```
  - isAwaiting
```
 final Boolean isAwaiting(String userId, String clientId)
```
    Whether this call is waiting for this device: a client tool, still awaiting its result, targeted at this person and this install.
    
    Parameters:
    
    userId - The person signed in on this device.
    
    clientId - This install, from AIClientIdentity.installId.
  - isAwaitingApproval
```
 final Boolean isAwaitingApproval(String userId, String clientId)
```
    Whether this call is waiting for this person to allow it, on this device: still awaiting approval, targeted at this person, and at this install when it names one (a client tool does; a server tool's question may be answered from any of their devices).
    
    Parameters:
    
    userId - The person signed in on this device.
    
    clientId - This install, from AIClientIdentity.installId.

Class AIToolCallPart

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AIToolCallPart

Method Detail

getIsDeclined

getDurationSeconds

getId

getName

getDisplayTitle

getStatus

getExecutor

getTargetUserId

getTargetClientId

getArguments

getSummary

getDurationMs

getApproval

isAwaiting

isAwaitingApproval