Touch

Class

Static helper for parallel click/swipe actions created by the UI or code via click(..., parallel=True) and swipe(..., parallel=True). You can collect click/swipe actions and send them together, or inspect click/swipe actions that are active or queued. The helper also supports cancelling active click/swipe actions (Android 8.0+ only).

Syntax

Touch

This class cannot be constructed directly.

Returns

—

Example

Touch.collect()
a = click(Point(300, 900), hold_ms=5000, parallel=True)
b = click(Point(780, 900), hold_ms=1000, delay_before=1000, parallel=True)
sent = Touch.send()
Touch.cancel(a)
Touch.wait()

Methods

7 methods

Touch.collect

Static Method

Enable collect mode for click/swipe calls with parallel=True. When enabled, parallel click/swipe calls are not sent immediately; they are collected and only sent after Touch.send(). This method works for both UI/code. If Touch.collect() is not enabled, parallel click/swipe calls are sent immediately, and later click/swipe calls must wait for the previous click/swipe to finish before they can run because running a later click/swipe immediately would cancel the previous one. You can intentionally cancel the previous click/swipe with Touch.cancel().

Syntax

Touch.collect()

Returns

None

Example

# Inspect or control collected touches
Touch.collect()
first = click((300, 900), hold_ms=1000, parallel=True)
second = click((780, 900), delay_before=300, parallel=True)
Touch.send()
Touch.wait()

Touch.send

Static Method

Send all click/swipe calls collected by Touch.collect() at once, return their matching numeric ids, then turn off Touch.collect() collection mode.

Syntax

Touch.send()

Returns

list[Number]

Example

# Inspect or control collected touches
Touch.collect()
first = click((300, 900), hold_ms=1000, parallel=True)
second = click((780, 900), delay_before=300, parallel=True)
Touch.send()
Touch.wait()

Touch.queued

Static Method

Return touch states currently in the queue.

Syntax

Touch.queued()

Returns

list[TouchState]

Example

# Inspect or control collected touches
Touch.collect()
first = click((300, 900), hold_ms=1000, parallel=True)
second = click((780, 900), delay_before=300, parallel=True)
Touch.send()
print(Touch.queued())
Touch.wait()

Touch.active

Static Method

Return active touch states.

Syntax

Touch.active()

Returns

list[TouchState]

Example

# Inspect or control collected touches
Touch.collect()
first = click((300, 900), hold_ms=1000, parallel=True)
second = click((780, 900), delay_before=300, parallel=True)
Touch.send()
print(Touch.active())
Touch.wait()

Touch.all

Static Method

Return recent and queued/active touch states.

Syntax

Touch.all()

Returns

list[TouchState]

Example

# Inspect or control collected touches
Touch.collect()
first = click((300, 900), hold_ms=1000, parallel=True)
second = click((780, 900), delay_before=300, parallel=True)
Touch.send()
print(Touch.all())
Touch.wait()

Touch.wait

Static Method

Wait for one numeric id, or every queued/active touch when id is None.

Syntax

Touch.wait(id=None)

Returns

TouchState | list[TouchState]

Example

# Inspect or control collected touches
Touch.collect()
first = click((300, 900), hold_ms=1000, parallel=True)
second = click((780, 900), delay_before=300, parallel=True)
Touch.send()
Touch.wait(first)
Touch.wait()

Touch.cancel

Static Method

Cancel one queued or active touch by numeric id. When id is None, cancels every queued/active touch and returns the accepted cancel count. Active cancel requires Android 8.0+; Android 7.x scripts fail with a clear error when an active touch is targeted.

Syntax

Touch.cancel(id=None)

Returns

Boolean | Int

Example

# Inspect or control collected touches
Touch.collect()
first = click((300, 900), hold_ms=1000, parallel=True)
second = click((780, 900), delay_before=300, parallel=True)
Touch.send()
# Active cancellation requires Android 8 or newer
Touch.cancel(second)
Touch.wait()