Class AnimationAdapter

Namespace

OpenQA.Selenium.DevTools.V147.Animation

Assembly

Selenium.WebDriver.dll

Represents an adapter for the Animation domain to simplify the command interface.

public class AnimationAdapter

Inheritance

object

AnimationAdapter

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

AnimationAdapter(IDevToolsSession)

Initializes a new instance of the AnimationAdapter class.

public AnimationAdapter(IDevToolsSession session)

Parameters

session IDevToolsSession

The IDevToolsSession to be used with this adapter.

Exceptions

ArgumentNullException

If session is null.

Properties

Session

Gets the DevToolsSession associated with the adapter.

public IDevToolsSession Session { get; }

Property Value

IDevToolsSession

Methods

Disable(DisableCommandSettings?, CancellationToken, int?, bool)

Disables animation domain notifications.

public Task<DisableCommandResponse?> Disable(DisableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command DisableCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<DisableCommandResponse>

Enable(EnableCommandSettings?, CancellationToken, int?, bool)

Enables animation domain notifications.

public Task<EnableCommandResponse?> Enable(EnableCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command EnableCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<EnableCommandResponse>

GetCurrentTime(GetCurrentTimeCommandSettings, CancellationToken, int?, bool)

Returns the current time of the an animation.

public Task<GetCurrentTimeCommandResponse> GetCurrentTime(GetCurrentTimeCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetCurrentTimeCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<GetCurrentTimeCommandResponse>

GetPlaybackRate(GetPlaybackRateCommandSettings?, CancellationToken, int?, bool)

Gets the playback rate of the document timeline.

public Task<GetPlaybackRateCommandResponse> GetPlaybackRate(GetPlaybackRateCommandSettings? command = null, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetPlaybackRateCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<GetPlaybackRateCommandResponse>

ReleaseAnimations(ReleaseAnimationsCommandSettings, CancellationToken, int?, bool)

Releases a set of animations to no longer be manipulated.

public Task<ReleaseAnimationsCommandResponse?> ReleaseAnimations(ReleaseAnimationsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ReleaseAnimationsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ReleaseAnimationsCommandResponse>

ResolveAnimation(ResolveAnimationCommandSettings, CancellationToken, int?, bool)

Gets the remote object of the Animation.

public Task<ResolveAnimationCommandResponse> ResolveAnimation(ResolveAnimationCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ResolveAnimationCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<ResolveAnimationCommandResponse>

SeekAnimations(SeekAnimationsCommandSettings, CancellationToken, int?, bool)

Seek a set of animations to a particular time within each animation.

public Task<SeekAnimationsCommandResponse?> SeekAnimations(SeekAnimationsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SeekAnimationsCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SeekAnimationsCommandResponse>

SetPaused(SetPausedCommandSettings, CancellationToken, int?, bool)

Sets the paused state of a set of animations.

public Task<SetPausedCommandResponse?> SetPaused(SetPausedCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetPausedCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetPausedCommandResponse>

SetPlaybackRate(SetPlaybackRateCommandSettings, CancellationToken, int?, bool)

Sets the playback rate of the document timeline.

public Task<SetPlaybackRateCommandResponse?> SetPlaybackRate(SetPlaybackRateCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetPlaybackRateCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetPlaybackRateCommandResponse>

SetTiming(SetTimingCommandSettings, CancellationToken, int?, bool)

Sets the timing of an animation node.

public Task<SetTimingCommandResponse?> SetTiming(SetTimingCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command SetTimingCommandSettings

cancellationToken CancellationToken

millisecondsTimeout int?

throwExceptionIfResponseNotReceived bool

Returns

Task<SetTimingCommandResponse>

Events

AnimationCanceled

Event for when an animation has been cancelled.

public event EventHandler<AnimationCanceledEventArgs>? AnimationCanceled

Event Type

EventHandler<AnimationCanceledEventArgs>

AnimationCreated

Event for each animation that has been created.

public event EventHandler<AnimationCreatedEventArgs>? AnimationCreated

Event Type

EventHandler<AnimationCreatedEventArgs>

AnimationStarted

Event for animation that has been started.

public event EventHandler<AnimationStartedEventArgs>? AnimationStarted

Event Type

EventHandler<AnimationStartedEventArgs>

AnimationUpdated

Event for animation that has been updated.

public event EventHandler<AnimationUpdatedEventArgs>? AnimationUpdated

Event Type

EventHandler<AnimationUpdatedEventArgs>