senselogic.sitevision.api.versioning

Interface PublisherBuilder

All Superinterfaces:

Builder<Publisher>

@Requireable(value="PublisherBuilder")
public interface PublisherBuilder
extends Builder<Publisher>

Builder for creating a Publisher with a specific setup of state.

Initial state of a PublisherBuilder is:

• publishDate is null == imminent publishing
• unpublishDate is null == no unpublishing
• notificationDate is null == no ("Best before") notification
• notifyMobileUsers is false == no mobile notification

Example of how to use PublisherBuilder and Publisher to publish a page at a given time using server-side JavaScript:

   // 1. Import PublishingUtil in apps (WebApp, RESTApp, Widget, MCPServer etc)
   // NOTE! Use the require function instead in other server-side JavaScripts (e.g. Script module), i.e:
   // const publishingUtil = require("PublishingUtil");
   import publishingUtil from "@sitevision/api/server/PublishingUtil";

   // 2. Create a publisher builder instance
   const publisherBuilder = publishingUtil.getPublisherBuilder();

   const page = ... // Get the page node to publish
   const date = ... // Create a specific publish date, or null for imminent publishing

   // 3. Create a publisher
   const publisher = publisherBuilder
                        .setPublishDate(date)
                        .build();

   // 4. Publish
   try {
      publisher.publish(page);
      console.log("Page published successfully!");
   } catch (e) {
      console.log("Failed to publish page");
   }
 

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

An instance of the Sitevision class implementing this interface can be obtained via PublishingUtil.getPublisherBuilder(). See PublishingUtil for how to obtain an instance of the PublishingUtil interface.

Since:

Sitevision 2026.08.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
Publisher	build() Creates a Publisher instance using currently specified state.
PublisherBuilder	setNotificationDate(Date aNotificationDate) Sets the ("Best before") notification date.
PublisherBuilder	setNotifyMobileUsers(boolean aNotifyMobileUsers) Whether mobile users should be notified when the page is published.
PublisherBuilder	setPublishDate(Date aPublishDate) Sets the publish date.
PublisherBuilder	setUnpublishDate(Date aUnpublishDate) Sets the unpublish date.

Method Detail

setPublishDate

PublisherBuilder setPublishDate(Date aPublishDate)

Sets the publish date.

A publish date before "now" will throw an IllegalStateException when calling build(). Use null for immediate publishing.

Parameters:

aPublishDate - the publish date to set, or null for immediate publishing

Returns:

this builder instance

setUnpublishDate

PublisherBuilder setUnpublishDate(Date aUnpublishDate)

Sets the unpublish date.

A unpublish date before "now" will throw an IllegalStateException when calling build().

A unpublish date must differ at least one minute from the actual publish date, otherwise an IllegalStateException will be thrown when calling build().

Parameters:

aUnpublishDate - the unpublish date to set, or null for no unpublishing

Returns:

this builder instance

setNotificationDate

PublisherBuilder setNotificationDate(Date aNotificationDate)

Sets the ("Best before") notification date.

A notification date before "now" will throw an IllegalStateException when calling build().

A notification date must be equal or after the actual publish date, otherwise an IllegalStateException will be thrown when calling build().

Parameters:

aNotificationDate - the notification date to set, or null for no notification

Returns:

this builder instance

setNotifyMobileUsers

PublisherBuilder setNotifyMobileUsers(boolean aNotifyMobileUsers)

Whether mobile users should be notified when the page is published.

Note that this setting in practice is only applicable when publishing a sv:article and current user must have PermissionUtil.Permission.SEND_PUSH_NOTIFICATIONS for it to have any effect.

Parameters:

aNotifyMobileUsers - true if mobile users should be notified, false otherwise

Returns:

this builder instance

build

Publisher build()
         throws IllegalStateException

Creates a Publisher instance using currently specified state.

Specified by:

build in interface Builder<Publisher>

Returns:

a Publisher instance

Throws:

IllegalStateException - if state for publisher execution is not valid, see individual set methods for value restrictions