LockScreenCallUI
LockScreenCallUI
LockScreenCallUI
LockScreenCallUI
Class
Definition
Handles communication to and from the lock screen.
public : sealed class LockScreenCallUI : ILockScreenCallUIpublic sealed class LockScreenCallUI : ILockScreenCallUIPublic NotInheritable Class LockScreenCallUI Implements ILockScreenCallUI// You can use this class in JavaScript.
- Attributes
| Device family |
Windows Desktop Extension SDK (introduced v10.0.10240.0)
|
| API contract |
Windows.ApplicationModel.Calls.LockScreenCallContract (introduced v1)
|
Properties
CallTitle CallTitle CallTitle CallTitle
Gets and sets a brief description of the nature of the call. This brief description is also called the call's accessible name; its form is "Video call with Jane Doe."
public : PlatForm::String CallTitle { get; set; }public string CallTitle { get; set; }Public ReadWrite Property CallTitle As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
A brief description of the nature of the call, for example, "Video call with Jane Doe."
Remarks
An app can use the CallTitle property to briefly describe the call. This call description is also called the accessible name and is provided to screen readers to describe your app when it runs on the lock screen. Don't include the name of your app in the accessible name; the operating system automatically includes the name of your app in the accessible name and provides that to the screen reader. The recommended form of the accessible name includes the mode of communication (video or audio) and the name of the other party. Here are some examples:
- Video call with Jane Doe
- Audio call with Jane Doe
- Video call with Jane Doe and three others
Methods
Dismiss() Dismiss() Dismiss() Dismiss()
Removes the app from the lock screen UI.
public : void Dismiss()public void Dismiss()Public Function Dismiss() As void// You can use this method in JavaScript.
Remarks
An app calls Dismiss to remove itself when the call is dropped, for example, the other party hangs up. When Dismiss returns, the lock screen no longer shows the app.
Events
Closed Closed Closed Closed
Occurs when the lock screen interaction is complete.
public : event TypedEventHandler Closed<LockScreenCallUI, object>public event TypedEventHandler Closed<LockScreenCallUI, object>Public Event Closed<LockScreenCallUI, object>// You can use this event in JavaScript.
Remarks
The Closed event fires when the app is removed from the lock screen by any means. After this event fires, the LockScreenCallUI object is no longer valid. Any further attempt to use the LockScreenCallUI object can either silently fail or explicitly fail with RPC_E_DISCONNECTED.
The Closed event doesn't use the object parameter passed to it. The object parameter exists only because event handlers require it.
EndRequested EndRequested EndRequested EndRequested
Occurs when the lock screen wants to end the call.
public : event TypedEventHandler EndRequested<LockScreenCallUI, LockScreenCallEndRequestedEventArgs>public event TypedEventHandler EndRequested<LockScreenCallUI, LockScreenCallEndRequestedEventArgs>Public Event EndRequested<LockScreenCallUI, LockScreenCallEndRequestedEventArgs>// You can use this event in JavaScript.
Remarks
The EndRequested event typically happens when the user taps the “End call” button on the lock screen, but the event can also happen under other conditions. For example, suppose a call comes in while a call is already active on the lock screen. By accepting the new call on the lock screen, the previous call ends.
When the EndRequested event handler returns, the app is removed from the lock screen. An app can extend its time on the lock screen by calling LockScreenCallEndRequestedEventArgs.GetDeferral to request a deferral. If the app requested a deferral, the app is removed from the lock screen when the deferral completes or the deadline passes.