Forums administrative commands 

Use the commands listed to perform administrative tasks for Forums. No file checkout or server restart is needed when using these commands.

The following sections define the commands that you can use when working with Forums. Each section describes the commands for a specific service. The commands are listed in alphabetical order.


ForumsConfigService commands

ForumsConfigService.checkOutConfig("<working_directory>", "<cell_name>")

ForumsConfigService.checkInConfig()


ForumsMemberService commands

ForumsMemberService.getMemberExtIdByEmail("email")

ForumsMemberService.getMemberExtIdByLogin("login")

ForumsMemberService.inactivateMemberByEmail("email")

ForumsMemberService.inactivateMemberByExtId("externalID")

ForumsMemberService.syncAllMembersByExtId( {"updateOnEmailLoginMatch": ["true" | "false"] } )

ForumsMemberService.syncBatchMemberExtIdsByEmail("emailFile" [, {"allowInactivate" : ["true" | "false"] } ] )

ForumsMemberService.syncBatchMemberExtIdsByLogin("loginFile" [, {"allowInactivate" : ["true" | "false"] } ] )

ForumsMemberService.syncMemberByExtId("currentExternalId"[, {"newExtId" : "id-string" [, "allowExtIdSwap" : ["true" | "false"] ] } ] )

ForumsMemberService.syncMemberExtIdByEmail("email" [, { "allowInactivate" : ["true" | "false"] } ])

ForumsMemberService.syncMemberExtIdByLogin("name" [, {"allowInactivate": ["true" | "false"] } ])


ForumsScheduler commands

ForumsScheduler.getTaskDetails(String taskName)

ForumsScheduler.pauseSchedulingTask(String taskName)

ForumsScheduler.resumeSchedulingTask(String taskName)


ForumsService commands

ForumsService.deleteForums(java.util.Vector forums)

ForumsService.exportSyncedResourceInfo(java.lang.String filePath, java.lang.String eventType)

ForumsService.fetchForums()

ForumsService.fetchForumsByName(java.lang.String forumName)


ForumsTopicsService commands

ForumsTopicsService.fetchTopics()

ForumsTopicsService.fetchTopicsByDate(String type, String begindate, String enddate)

ForumsTopicsService.fetchTopicsCreatedByMember(String extId, String type)

ForumsTopicsService.fetchTopicById(String topicuuid)

ForumsTopicsService.deleteTopics(Vector <forumtopics>)


ForumsTrashService commands

ForumsTrashService.fetchForumsTrash()

ForumsTrashService.fetchTopicsTrash()

ForumsTrashService.purgeForumsTrash(vector <hashtable>)

ForumsTrashService.purgeTopicsTrash(vector <hashtable>)

ForumsTrashService.undeleteForumsTrash(vector <hashtable>)

ForumsTrashService.undeleteTopicTrash(vector <hashtable>)


Parent topic

Running Forums administrative commands

Related concepts
Synchronize user data using administrative commands


Related tasks


Running administrative commands
Comparing remote application data with the Communities database


   

 

});