dev.azure.com/aidainnovazione0090/DeviceManager/_git/go-mod-core-contracts@v1.0.2/clients/interfaces/transmission.go (about)

     1  //
     2  // Copyright (C) 2021 IOTech Ltd
     3  //
     4  // SPDX-License-Identifier: Apache-2.0
     5  
     6  package interfaces
     7  
     8  import (
     9  	"context"
    10  
    11  	"dev.azure.com/aidainnovazione0090/DeviceManager/_git/go-mod-core-contracts/dtos/common"
    12  	"dev.azure.com/aidainnovazione0090/DeviceManager/_git/go-mod-core-contracts/dtos/responses"
    13  	"dev.azure.com/aidainnovazione0090/DeviceManager/_git/go-mod-core-contracts/errors"
    14  )
    15  
    16  // TransmissionClient defines the interface for interactions with the Transmission endpoint on the EdgeX Foundry support-notifications service.
    17  type TransmissionClient interface {
    18  	// TransmissionById query transmission by id.
    19  	TransmissionById(ctx context.Context, id string) (responses.TransmissionResponse, errors.EdgeX)
    20  	// TransmissionsByTimeRange query transmissions with time range, offset and limit
    21  	TransmissionsByTimeRange(ctx context.Context, start int, end int, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)
    22  	// AllTransmissions query transmissions with offset and limit
    23  	AllTransmissions(ctx context.Context, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)
    24  	// TransmissionsByStatus queries transmissions with status, offset and limit
    25  	TransmissionsByStatus(ctx context.Context, status string, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)
    26  	// DeleteProcessedTransmissionsByAge deletes the processed transmissions if the current timestamp minus their created timestamp is less than the age parameter.
    27  	DeleteProcessedTransmissionsByAge(ctx context.Context, age int) (common.BaseResponse, errors.EdgeX)
    28  	// TransmissionsBySubscriptionName query transmissions with subscriptionName, offset and limit
    29  	TransmissionsBySubscriptionName(ctx context.Context, subscriptionName string, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)
    30  	// TransmissionsByNotificationId query transmissions with notification id, offset and limit
    31  	TransmissionsByNotificationId(ctx context.Context, id string, offset int, limit int) (responses.MultiTransmissionsResponse, errors.EdgeX)
    32  }