Add documentation for Cancel Sync client activity and button action #10707
+42
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jdiehl
suggested changes
Feb 3, 2026
|
|
||
| ## Introduction | ||
|
|
||
| The **Cancel synchronization** activity cancels a running synchronization. You can start synchronization again later. For synchronization behavior, see [Synchronize](/refguide/mobile/building-efficient-mobile-apps/offlinefirst-data/synchronization/). |
Contributor
There was a problem hiding this comment.
I would change "you can start synchronization later" with "you can trigger another synchronization later". This avoids suggestion that the canceled sync can be restarted
|
|
||
| ## Properties | ||
|
|
||
| There are two sets of properties for this activity, those in the dialog box on the left, and those in the properties pane on the right: |
Contributor
There was a problem hiding this comment.
Is this really necessary? This explains how the editor work and is not specific to this action. I would remove it
|
|
||
| You can open a dialog box to configure this action by clicking the ellipsis (**…**) next to the action. | ||
|
|
||
| You can also open the dialog box by double-clicking the activity, or right-clicking the activity and selecting **Properties**. |
Contributor
There was a problem hiding this comment.
Can you rewrite this to explain what the action parameter is used for instead of how to use the editor?
|
|
||
| ### Cancel Synchronization {#cancel-synchronization} | ||
|
|
||
| The **Cancel synchronization** event cancels a running synchronization. You can start synchronization again later. |
Collaborator
|
@ashish-kumar-offline @jdiehl Please let me know when this is ready for technical writer's review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.