ZyncTagsManager

Public API manager for tag operations in the Zync SDK.

This manager provides the public interface for tag-related functionality, including editing tags, deleting tags, and searching for tags by name.

Usage:

val result = zync.tags?.editTag("tag_uid_123", "New Tag Name")
when (result) {
    is ZyncResult.Success -> {
        println("Tag edited successfully")
    }
    is ZyncResult.Failure -> {
        println("Error: ${result.error.message}")
    }
}

Functions

addTag

suspend fun addTag(module: ZuperModule, tagName: String): AddTagResult

Add a new company tag to a specific module.

deleteTag

suspend fun deleteTag(tagUid: String): ZyncResult

Delete a company tag by marking it as deleted.

editTag

suspend fun editTag(tagUid: String, newTagName: String): ZyncResult

Edit an existing company tag name.

getTags

suspend fun getTags(module: ZuperModule, searchQuery: String? = null): MasterTagsResult

Get tags for any module with offline-first approach. Returns cached tags immediately, then triggers sync in background if needed.

getTagsByName

suspend fun getTagsByName(module: ZuperModule, tagNames: List<String>): GetTagsByNameResult

Find tags by matching tag names within a specific module.

observeTagChanges

suspend fun observeTagChanges(module: ZuperModule): Flow<TagChangeEvent>

Observe tag changes for a specific module. Returns a flow that emits TagChangeEvent objects when tags are updated via delta sync.