|
Timeline Framework C++ Edition
|
#include <wclTimeline.h>
Public Member Functions | |
| CwclUserActivity () | |
| Creates new User Activity object. | |
| virtual | ~CwclUserActivity () |
| Frees the object. | |
| int | BeginSession () |
| Starts User Activity session. | |
| int | EndSession () |
| Ends User Activity session. | |
| bool | GetActive () const |
| Gets the USer Activity Session state. | |
| __declspec (property(get=GetActive)) bool Active | |
| Gets the USer Activity Session state. | |
| tstring | GetDescription () const |
| Gets the description text that is used for the details tile for this User Activity. | |
| void | SetDescription (const tstring &value) |
| Sets the description text that is used for the details tile for this User Activity. | |
| __declspec (property(get=GetDescription, put=SetDescription)) tstring Description | |
| Gets and sets the description text that is used for the details tile for this User Activity. | |
| tstring | GetDisplayText () const |
| Gets the display text that is used for the details tile text for this User Activity. | |
| void | SetDisplayText (const tstring &value) |
| Sets the display text that is used for the details tile text for this User Activity. | |
| __declspec (property(get=GetDisplayText, put=SetDisplayText)) tstring DisplayText | |
| Gets and sets the display text that is used for the details tile text for this User Activity. | |
| tstring | GetId () const |
| Gets the Activity ID that was assigned to this User Activity when it was created. | |
| __declspec (property(get=GetId)) tstring Id | |
| Gets the Activity ID that was assigned to this User Activity when it was created. | |
| tstring | GetParams () const |
| Gets the application activation parameters. | |
| void | SetParams (const tstring &value) |
| Sets the application activation parameters. | |
| __declspec (property(get=GetParams, put=SetParams)) tstring Params | |
| Gets and sets the application activation parameters. | |
| tstring | GetProtocol () const |
| Gets the Activity's activation protocol. | |
| void | SetProtocol (const tstring &value) |
| Sets the Activity's activation protocol. | |
| __declspec (property(get=GetProtocol, put=SetProtocol)) tstring Protocol | |
| Gets and sets the Activity's activation protocol. | |
| wclUserActivityState | GetState () const |
| Gets the state of this User Activity. | |
| __declspec (property(get=GetState)) wclUserActivityState State | |
| Gets the state of this User Activity. | |
| tstring | GetTitle () const |
| Gets the text which is shown in the top banner of the activity card. | |
| void | SetTitle (const tstring &value) |
| Set the text which is shown in the top banner of the activity card. | |
| __declspec (property(get=GetTitle, put=SetTitle)) tstring Title | |
| Gets and set the text which is shown in the top banner of the activity card. | |
The class represents a User Activity.
A User Activity is created by an application during its execution to notify the system of a user work stream that can be continued at another time. It provides information about a task the user is engaged in.
A User Activity encapsulates a user's task that can be continued at a later time. Creating a User Activity causes that activity to appear in Windows Timeline and in Cortana's Pick up where I left off feature. Timeline is a rich task view that shows a chronological view of what you’ve been working on. It can also include what you were working on across devices. For example, a mail app could create a User Activity when the user starts creating a new email message. The user could pause working on the email and then work on it later on the same machine, or even another device.
An application must never create this object directly. Instead of that an application must use CwclTimelineChannel component to create or get an User Activity objects.
The User Activity is supported on Windows 10 16299 and above.
1.9.7