---
name: "wayland_xdg_activation_token_v1_t"
section: "3"
platform: "linux"
package: "waylandpp-dev"
version: "1.0.0-6+b2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/wayland_xdg_activation_token_v1_t"
---

# wayland\_xdg\_activation\_token\_v1\_t(3)

an exported activation handle

## NAME

wayland::xdg\_activation\_token\_v1\_t - an exported activation handle

## SYNOPSIS

`#include <wayland-client-protocol-unstable.hpp>`

Inherits **wayland::proxy\_t**.

### Public Types

enum class **wrapper\_type** { **standard**, **display**, **foreign**, **proxy\_wrapper** }\

### Public Member Functions

void **set\_serial** (uint32\_t serial, **seat\_t** const &seat)\
 specifies the seat and serial of the activating event  void **set\_app\_id** (std::string const &app\_id)\
 specifies the application being activated  void **set\_surface** (**surface\_t** const &surface)\
 specifies the application being activated  void **commit** ()\
 issues the token request  std::function\< void(std::string)\> & **on\_done** ()\
 the exported activation token  uint32\_t **get\_id** () const\
 Get the id of a proxy object.  std::string **get\_class** () const\
 Get the interface name (class) of a proxy object.  uint32\_t **get\_version** () const\
 Get the protocol object version of a proxy object.  **wrapper\_type** **get\_wrapper\_type** () const\
 Get the type of a proxy object.  void **set\_queue** (**event\_queue\_t** queue)\
 Assign a proxy to an event queue.  wl\_proxy \* **c\_ptr** () const\
 Get a pointer to the underlying C struct.  bool **proxy\_has\_object** () const\
 Check whether this wrapper actually wraps an object.  **operator bool** () const\
 Check whether this wrapper actually wraps an object.  bool **operator==** (const **proxy\_t** &right) const\
 Check whether two wrappers refer to the same object.  bool **operator!=** (const **proxy\_t** &right) const\
 Check whether two wrappers refer to different objects.  void **proxy\_release** ()\
 Release the wrapped object (if any), making this an empty wrapper.

### Static Public Attributes

static constexpr std::uint32\_t **set\_serial\_since\_version** = 1\
 Minimum protocol version required for the **set\_serial** function.  static constexpr std::uint32\_t **set\_app\_id\_since\_version** = 1\
 Minimum protocol version required for the **set\_app\_id** function.  static constexpr std::uint32\_t **set\_surface\_since\_version** = 1\
 Minimum protocol version required for the **set\_surface** function.  static constexpr std::uint32\_t **commit\_since\_version** = 1\
 Minimum protocol version required for the **commit** function.

## Detailed Description

an exported activation handle

An object for setting up a token and receiving a token handle that can be passed as an activation token to another client.

The object is created using the xdg\_activation\_v1.get\_activation\_token request. This object should then be populated with the app\_id, surface and serial information and committed. The compositor shall then issue a done event with the token. In case the request's parameters are invalid, the compositor will provide an invalid token.

Definition at line **6742** of file **wayland-client-protocol-unstable.hpp**.

## Member Enumeration Documentation

### enum class wayland::proxy\_t::wrapper\_type` [strong]`, ` [inherited]`

Underlying wl\_proxy type and properties of a **proxy\_t** that affect construction, destruction, and event handling

**Enumerator**

- *standard*

  *C pointer is a standard type compatible with wl\_proxy\*. Events are dispatched and it is destructed when the* **proxy\_t** *is destructed. User data is set.*

- *display*

  *C pointer is a wl\_display\*. No events are dispatched, wl\_display\_disconnect is called when the* **proxy\_t** *is destructed. User data is set.*

- *foreign*

  *C pointer is a standard type compatible with wl\_proxy\*, but another library owns it and it should not be touched in a way that could affect the operation of the other library. No events are dispatched, wl\_proxy\_destroy is not called when the* **proxy\_t** *is destructed, user data is not touched. Consequently, there is no reference counting for the* **proxy\_t***. Lifetime of such wrappers should preferably be short to minimize the chance that the owning library decides to destroy the wl\_proxy.*

- *proxy\_wrapper*

  *C pointer is a wl\_proxy\* that was constructed with wl\_proxy\_create\_wrapper. No events are dispatched, wl\_proxy\_wrapper\_destroy is called when the* **proxy\_t** *is destroyed. Reference counting is active. A reference to the* **proxy\_t** *creating this proxy wrapper is held to extend its lifetime until after the proxy wrapper is destroyed.*

*Definition at line* **116** *of file* **wayland-client.hpp***.*

## Member Function Documentation

### wl\_proxy \* wayland::proxy\_t::c\_ptr () const` [inherited]`

*Get a pointer to the underlying C struct.*

**Returns**

*The underlying wl\_proxy wrapped by this* **proxy\_t** *if it exists, otherwise an exception is thrown*

### void xdg\_activation\_token\_v1\_t::commit ()

*issues the token request Requests an activation token based on the different parameters that have been offered through set\_serial, set\_surface and set\_app\_id.*

*Definition at line* **8758** *of file* **wayland-client-protocol-unstable.cpp***.*

### std::string wayland::proxy\_t::get\_class () const` [inherited]`

*Get the interface name (class) of a proxy object.*

**Returns**

*The interface name of the object associated with the proxy*

### uint32\_t wayland::proxy\_t::get\_id () const` [inherited]`

*Get the id of a proxy object.*

**Returns**

*The id the object associated with the proxy*

### uint32\_t wayland::proxy\_t::get\_version () const` [inherited]`

*Get the protocol object version of a proxy object. Gets the protocol object version of a proxy object, or 0 if the proxy was created with unversioned API.*

*A returned value of 0 means that no version information is available, so the caller must make safe assumptions about the object's real version.*

**display\_t** *will always return version 0.*

**Returns**

*The protocol object version of the proxy or 0*

### wrapper\_type wayland::proxy\_t::get\_wrapper\_type () const` [inline]`, ` [inherited]`

*Get the type of a proxy object.*

*Definition at line* **302** *of file* **wayland-client.hpp***.*

### std::function\< void(std::string)\> & xdg\_activation\_token\_v1\_t::on\_done ()

*the exported activation token*

**Parameters**

*token the exported activation token*

*The 'done' event contains the unique token of this activation request and notifies that the provider is done.*

*Applications will typically receive the token through the XDG\_ACTIVATION\_TOKEN environment variable as set by its launcher, and should unset the environment variable right after this request, in order to avoid propagating it to child processes.*

*Applications implementing the D-Bus interface org.freedesktop.Application should get their token under XDG\_ACTIVATION\_TOKEN on their platform\_data.*

*Presentation tokens may be transferred across clients through means not described in this protocol.*

*Definition at line* **8764** *of file* **wayland-client-protocol-unstable.cpp***.*

### wayland::proxy\_t::operator bool () const` [inherited]`

*Check whether this wrapper actually wraps an object.*

**Returns**

*true if there is an underlying object, false if this wrapper is empty*

### bool wayland::proxy\_t::operator!= (const proxy\_t & right) const` [inherited]`

*Check whether two wrappers refer to different objects.*

### bool wayland::proxy\_t::operator== (const proxy\_t & right) const` [inherited]`

*Check whether two wrappers refer to the same object.*

### bool wayland::proxy\_t::proxy\_has\_object () const` [inherited]`

*Check whether this wrapper actually wraps an object.*

**Returns**

*true if there is an underlying object, false if this wrapper is empty*

### void wayland::proxy\_t::proxy\_release ()` [inherited]`

*Release the wrapped object (if any), making this an empty wrapper. Note that* **display\_t** *instances cannot be released this way. Attempts to do so are ignored.*

**Examples** **foreign\_display.cpp***.*

### void xdg\_activation\_token\_v1\_t::set\_app\_id (std::string const & app\_id)

*specifies the application being activated*

**Parameters**

*app\_id the application id of the client being activated.*

*The requesting client can specify an app\_id to associate the token being created with it.*

*Must be sent before commit. This information is optional.*

*Definition at line* **8746** *of file* **wayland-client-protocol-unstable.cpp***.*

### void wayland::proxy\_t::set\_queue (event\_queue\_t queue)` [inherited]`

*Assign a proxy to an event queue.*

**Parameters**

*queue The event queue that will handle this proxy*

*Assign proxy to event queue. Events coming from proxy will be queued in queue instead of the display's main queue.*

*See also:* **display\_t::dispatch\_queue()***.*

**Examples** **proxy\_wrapper.cpp***.*

### void xdg\_activation\_token\_v1\_t::set\_serial (uint32\_t serial, seat\_t const & seat)

*specifies the seat and serial of the activating event*

**Parameters**

*serial the serial of the event that triggered the activation* \
 *seat the wl\_seat of the event*

*Provides information about the seat and serial event that requested the token.*

*Must be sent before commit. This information is optional.*

*Definition at line* **8740** *of file* **wayland-client-protocol-unstable.cpp***.*

### void xdg\_activation\_token\_v1\_t::set\_surface (surface\_t const & surface)

*specifies the application being activated*

**Parameters**

*surface the requesting surface*

*The requesting client can specify a surface to associate the token being created with it.*

*Must be triggered before commit. This information is optional.*

*Definition at line* **8752** *of file* **wayland-client-protocol-unstable.cpp***.*

## Member Data Documentation

### constexpr std::uint32\_t wayland::xdg\_activation\_token\_v1\_t::commit\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **commit** *function.*

*Definition at line* **6821** *of file* **wayland-client-protocol-unstable.hpp***.*

### constexpr std::uint32\_t wayland::xdg\_activation\_token\_v1\_t::set\_app\_id\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_app\_id** *function.*

*Definition at line* **6794** *of file* **wayland-client-protocol-unstable.hpp***.*

### constexpr std::uint32\_t wayland::xdg\_activation\_token\_v1\_t::set\_serial\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_serial** *function.*

*Definition at line* **6779** *of file* **wayland-client-protocol-unstable.hpp***.*

### constexpr std::uint32\_t wayland::xdg\_activation\_token\_v1\_t::set\_surface\_since\_version = 1` [static]`, ` [constexpr]`

*Minimum protocol version required for the* **set\_surface** *function.*

*Definition at line* **6809** *of file* **wayland-client-protocol-unstable.hpp***.*

## Author

*Generated automatically by Doxygen for Wayland++ from the source code.*