FaxBack Developer NSSOAP - reschedule

reschedule_message

The reschedule_message method changes the delivery schedule for a message in the fax server send queue. If the provided schedule time is for a time earlier than the current time, the message will become immediately eligible for delivery.

RESCHEDULE_MESSAGE_RESULT reschedule_message(
string user_name,	// Fax server user name
string user_password,	// Fax server user password
string message_handle,	// Message to reschedule
DateTime schedule_time_utc	// New schedule time (UTC)
)

Parameters:

user_name	A NET SatisFAXtion user name.
user_password	The password for the user.
message_handle	The handle of the message to reschedule. To obtain a message handle, call get_message_q and use the message_handle field of a Q_MESSAGE object, or use the message handle returned from send_message.
schedule_time_utc	A new schedule time for the message in Coordinated Universal Time (UTC).

Return Value:

A RESCHEDULE_MESSAGE_RESULT object containing a result code and string.

Example:

public bool reschedule_messsage(string message_handle)
  {
  NSSOAP ns = new NSSOAP();

  RESCHEDULE_MESSAGE_RESULT rm =
    ns.reschedule_message(
                  "supervisor",
                  "",
                  message_handle,
                  RescheduleDateTimePicker.Value.ToUniversalTime());

  if (rm.status_num != STATUS_NUM.NoError)
    {
    MessageBox.Show("Unable to reschedule:" + rm.status_string);

    return(false);
    }

  return(true);
  }