Eight.Message.ToastOptions

Options class with all the available settings for a toast notification through Eight.js. Includes the following options for toasts that are shown immediately:
  • header: Text to display. If this is set and nothing else, then toastText01 template will be used.
  • body: Text to display. If this is set and nothing else, then toastText01 template will be used. If this and header are set, then toastText02 will be used.
  • imgUri: Image to display. If this is set and only header or body is set, toastImageAndText01 template will be used. If header, body and this are set, toastImageAndText02 will be used.
  • launchData: If this is set, this will be the data that is passed to the activated event handler for the application.

... and additionally includes the following options for toasts that are scheduled for a later time:
  • scheduledTime: This is required only when calling Eight.Message.scheduleToast. Controls the time at which the toast will be displayed. Must be a value in the future.
  • snoozeInterval: Number of minutes that the toast can be snoozed.
  • maxSnoozeCount: Maximum number of times the toast can be snoozed.

Example

var opts = new Eight.Message.ToastOptions();
opts.header = "This is a toast";
opts.body = "Do not be afraid, this is only a toast.";
opts.imgUri = "ms-appx:///images/smalllogo.png";
opts.scheduledTime = new Date();
opts.snoozeInterval = 60;
opts.maxSnoozeCount = 1;

Last edited Feb 13, 2013 at 3:31 PM by gotdibbs, version 2

Comments

No comments yet.