-
Notifications
You must be signed in to change notification settings - Fork 782
Add documentation for Cancel Sync client activity and button action #10707
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Yiyun333
merged 6 commits into
mendix:development
from
ashish-kumar-offline:added-docs-for-cancel-sync
Mar 2, 2026
Merged
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b555a40
added docs for cancel sync
ashish-kumar-offline dd1d9ac
pr comments fixes
ashish-kumar-offline 9ef890e
Tech writer's review
Yiyun333 21423a6
Small style fix
Yiyun333 cecfbe4
Title fix
Yiyun333 d972ac8
Update screenshot
Yiyun333 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
38 changes: 38 additions & 0 deletions
38
...microflows-and-nanoflows/activities/client-activities/cancel-synchronization.md
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: "Cancel synchronization" | ||
| url: /refguide/cancel-synchronization/ | ||
| weight: 70 | ||
| #If moving or renaming this doc file, implement a temporary redirect and let the respective team know they should update the URL in the product. See Mapping to Products for more details. | ||
| --- | ||
|
|
||
| {{% alert color="info" %}} | ||
| This activity can only be used in nanoflows. | ||
| {{% /alert %}} | ||
|
|
||
| ## Introduction | ||
|
|
||
| The **Cancel synchronization** activity cancels a running synchronization. You can trigger another synchronization later. For more information on the synchronization behavior, see [Synchronize](/refguide/mobile/building-efficient-mobile-apps/offlinefirst-data/synchronization/). | ||
|
|
||
| ## 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: | ||
|
|
||
| {{< figure src="/attachments/refguide/modeling/application-logic/microflows-and-nanoflows/activities/client-activities/cancel-synchronization/cancel-synchronization-properties.png" class="no-border" >}} | ||
|
Yiyun333 marked this conversation as resolved.
Outdated
|
||
|
|
||
| The **Cancel synchronization** properties pane consists of the following sections: | ||
|
|
||
| * [Action](#action) | ||
| * [Common](#common) | ||
|
|
||
| ## Action Section {#action} | ||
|
|
||
| The **Action** section of the properties pane shows the action associated with this activity. It defines what happens when the **Cancel synchronization** activity is executed and specifies that the running synchronization process will be cancelled. | ||
|
|
||
| ## Common Section {#common} | ||
|
|
||
| {{% snippet file="/static/_includes/refguide/microflow-common-section-link.md" %}} | ||
|
|
||
| ## Limitations | ||
|
|
||
| * If the synchronization is in a step that applies file-related changes, it is not canceled to avoid leaving the system in an inconsistent state. | ||
| * If the synchronization is already in its final steps, cancellation is not applied because most of the processing is already complete. The process is therefore allowed to finish. | ||
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
Binary file added
BIN
+221 KB
.../client-activities/cancel-synchronization/cancel-synchronization-properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this really necessary? This explains how the editor work and is not specific to this action. I would remove it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jdiehl This explains the screenshot below. I will still keep it to maintain consistency with other documentation.