StartSending

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Servizi Core > Jamio Sending >

StartSending

Avvia il tracciamento, tramite una risorsa Dati, di un processo di business di invio di un'informazione da Jamio openwork a uno o più corrispondenti.

 

Metodo

JamioSending/StartSending

 

Input

Nome

Descrizione

Tipo

Opzionale

serverAddress

Indirizzo del server per domini esterni (o "" per il dominio corrente).

String

Y

token

Il token di sessione (per la sessione corrente nel dominio corrente potrebbe essere null o vuoto).

String

Y

resource

Riferimento della risorsa Dati che deve tracciare la spedizione che si sta avviando.

Reference

 

correspondents

Lista dei riferimenti dei Corrispondenti della spedizione. In assenza di una Risorsa Jamio openwork che individua il Corrispondente, è possibile specificare un collegamento con valorizzata solo la proprietà Name.

List of reference

 

 

Commenti

Il metodo è utile ad avviare la spedizione di un'informazione da Jamio ad uno o più corrispondenti. Il metodo prevede in input:

il riferimento della risorsa Dati che deve tracciare la spedizione che si sta avviando;

la lista dei corrispondenti della spedizione.

 

Il metodo imposta sulla risorsa Dati che traccia la spedizione:

lo stato della spedizione (proprietà SendingStatus) da none a pending, ad indicare che la trasmissione è stata avviata ed è in attesa di essere gestita;

la percentuale di completamento della spedizione (proprietà SendingProgress) pari a zero;

la direzione della spedizione (proprietà SendingDirection) pari a 2, ovvero spedizione in uscita.

 

Il metodo crea un CorrespondentInfo per ogni elemento specificato nella lista dei corrispondenti. Alla risorsa Dati che traccia la spedizione, viene associata la lista dei corrispondenti, e per ogni corrispondente viene impostato lo stato (SendingStatus) a pending. Eventuali corrispondenti duplicati (ovvero collegamenti con proprietà Name e URL uguali) saranno riportati in lista una sola volta. Se nella lista dei corrispondenti sono specificati collegamenti che possiedono la stessa URL ma con proprietà Name distinte, il metodo genera un'errore. A seguito dell'esecuzione del metodo StartSending, lo stato della spedizione (proprietà SendingStatus della risorsa Dati che traccia la spedizione) può essere modificato solo mediante:

l'inserimento di un tracking message;

l'aggiunta di un percorso di spedizione (SendingPath) per un corrispondente della lista;

l'interruzione della spedizione (tramite metodo AbortSending);

L'esecuzione del metodo avvia una spedizione pertanto genera un evento su spedizione con proprietà action uguale a StartSend.

 

Autorizzazioni

Per eseguire il metodo è necessario possedere il permesso di modifica sulla risorsa Dati che traccia la spedizione.

 

Stato della risorsa

Il metodo può essere eseguito se la proprietà SendingStatus della risorsa Dati che traccia la spedizione è uguale a None, diversamente il metodo restituisce un errore.