ScheduledItem.Schedule método (String)

Agenda um objeto SPListItem para ser automaticamente aprovada (início) e será cancelada (terminar) em datas especificadas.

Namespace:  Microsoft.SharePoint.Publishing
Assembly:  Microsoft.SharePoint.Publishing (em Microsoft.SharePoint.Publishing.dll)

Sintaxe

'Declaração
Public Sub Schedule ( _
    approvalComment As String _
)
'Uso
Dim instance As ScheduledItem
Dim approvalComment As String

instance.Schedule(approvalComment)

public void Schedule(
    string approvalComment
)

Parâmetros

• approvalComment
  Tipo: System.String

  Comentários para ser definido quando o SPListItem for aprovada se a StartDate está no futuro.

Exceções

Exceção	Condição
[Microsoft.SharePoint.SPException]	Você pode agendar documentos apenas em uma lista secundária de versão habilitada.
[Microsoft.SharePoint.SPException]	Você pode agendar documentos apenas em uma lista com aprovação de conteúdo habilitada.
[Microsoft.SharePoint.SPException]	O usuário atual não tem permissões suficientes para executar esta ação.
[Microsoft.SharePoint.SPException]	Não é possível agendar uma data inicial para um item atualmente aprovado. Itens devem estar no estado de versão secundária.
[Microsoft.SharePoint.SPException]	Não há suporte para agendamento nesse banco de dados de conteúdo. Use aprovar ou Cancelar publicação.

Comentários

Um SPListItem de agendamento indica que ele já foi efetivamente aprovado. As mesmas permissões necessárias para o agendamento são necessárias para aprovação.

Os valores StartDate e EndDate são usados para determinar a agenda de publicação. Se a data inicial for anterior a agora, o SPListItem será publicado imediatamente. Caso contrário, ela está agendada para publicação em uma data futura. Se a data final for especificada, o SPListItem está programado para publicação em uma data futura.

Exemplos

Este exemplo define uma data de início e de término para um objeto ScheduledItem e agenda o item para que ele é publicado quando for alcançada a data de início e é cancelada quando for alcançada a data de término.

Antes de compilar e executar esse exemplo, verifique se o SPListItem é um item de lista em uma biblioteca de documentos que oferece suporte ao agendamento.

using ScheduledItem = Microsoft.SharePoint.Publishing.ScheduledItem;
using SPModerationStatusType = Microsoft.SharePoint.SPModerationStatusType;
using SPListItem = Microsoft.SharePoint.SPListItem;
using DateTime = System.DateTime;

namespace Microsoft.SDK.SharePointServer.Samples
{
    public static class ScheduledItemCodeSamples
    {
        public static void SetDatesAndSchedule(SPListItem listItem, 
          DateTime startDate, DateTime endDate)
        {
            // Set the input parameter values with
            // your own values.
            
            //
            // validate the input parameters
            if (null == listItem)
            {
                throw new System.ArgumentNullException("listItem");
            }

            // Get the ScheduledItem wrapper for the SPListItem
            // that was passed in.
            //
            ScheduledItem scheduledItem = null;
            if (ScheduledItem.IsScheduledItem(listItem))
            {
                scheduledItem = ScheduledItem.GetScheduledItem(listItem);
            }
            else
            {
                throw new System.ArgumentException
                  ("The document library containing this SPListItem must support scheduling", 
                  "listItem");
            }

            // Set and save the date values.
            scheduledItem.StartDate = startDate;
            scheduledItem.EndDate = endDate;
            scheduledItem.ListItem.Update();

            // Schedule the item so that the StartDate and EndDate
            // take effect.
            scheduledItem.Schedule();
        }        
    }
}

Imports ScheduledItem = Microsoft.SharePoint.Publishing.ScheduledItem
Imports SPModerationStatusType = Microsoft.SharePoint.SPModerationStatusType
Imports SPListItem = Microsoft.SharePoint.SPListItem

Namespace Microsoft.SDK.SharePointServer.Samples
    Public NotInheritable Class ScheduledItemCodeSamples
        Private Sub New()
        End Sub
        Public Shared Sub SetDatesAndSchedule(ByVal listItem As SPListItem, ByVal startDate As Date, ByVal endDate As Date)
            ' Set the input parameter values with
            ' your own values.

            '
            ' validate the input parameters
            If Nothing Is listItem Then
                Throw New System.ArgumentNullException("listItem")
            End If

            ' Get the ScheduledItem wrapper for the SPListItem
            ' that was passed in.
            '
            Dim scheduledItem As ScheduledItem = Nothing
            If ScheduledItem.IsScheduledItem(listItem) Then
                scheduledItem = ScheduledItem.GetScheduledItem(listItem)
            Else
                Throw New System.ArgumentException ("The document library containing this SPListItem must support scheduling", "listItem")
            End If

            ' Set and save the date values.
            scheduledItem.StartDate = startDate
            scheduledItem.EndDate = endDate
            scheduledItem.ListItem.Update()

            ' Schedule the item so that the StartDate and EndDate
            ' take effect.
            scheduledItem.Schedule()
        End Sub
    End Class
End Namespace

Ver também

Referência

ScheduledItem classe

ScheduledItem membros

Schedule em sobrecarga

Microsoft.SharePoint.Publishing namespace

StartDate

EndDate

Approve

Schedule