FBuildListRetriever

Helper class to query a list of builds for a project of a specified build type in a P4 stream.

API > API/Developer > API/Developer/Zen

Helper class to query a list of builds for a project of a specified build type in a P4 stream. Call ConnectToBuildService() first to establish connection, before calling QueryBuilds() to retrieve the builds, build query is asynchronous.

   
Name FBuildListRetriever
Type class
Header File /Engine/Source/Developer/Zen/Public/Experimental/BuildListRetriever.h
Include Path #include "Experimental/BuildListRetriever.h"

Syntax

class FBuildListRetriever : public TSharedFromThis< FBuildListRetriever >

Inheritance Hierarchy

  • TSharedFromThis< FBuildListRetriever > → FBuildListRetriever

Constructors

Name Remarks Include Path Unreal Specifiers

FBuildListRetriever()

   Experimental/BuildListRetriever.h  

Structs

Name Remarks
FBucketInfo  
FBuildGroup  
FBuildType  

Enums

Public

Name Remarks
EBuildType  

Typedefs

Name Type Remarks Include Path
FOnGroupQueriesComplete TUniqueFunction< void(const TArrayView< TSharedRef< FBuildGroup > > &)>   Experimental/BuildListRetriever.h
FOnQueriesComplete TUniqueFunction< void(const FPlatformBuildsMap &)>   Experimental/BuildListRetriever.h
FOnReadyForQuery TUniqueFunction< void()>   Experimental/BuildListRetriever.h
FPlatformBuildsMap TMap< FString, TArray< int32 > >   Experimental/BuildListRetriever.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bConnected bool   Experimental/BuildListRetriever.h  
BuildType FString   Experimental/BuildListRetriever.h  
OnGroupQueriesCompleteCallback FOnGroupQueriesComplete   Experimental/BuildListRetriever.h  
OnQueriesCompleteCallback FOnQueriesComplete   Experimental/BuildListRetriever.h  
OnReadyForQuery FOnReadyForQuery   Experimental/BuildListRetriever.h  
PerPlatformBuilds FPlatformBuildsMap   Experimental/BuildListRetriever.h  
ProjectName FString   Experimental/BuildListRetriever.h  
ReadyToIssueBuildQuery bool   Experimental/BuildListRetriever.h  
ServiceInstance TSharedPtr< FBuildServiceInstance >   Experimental/BuildListRetriever.h  
Stream FString   Experimental/BuildListRetriever.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ConnectToBuildService()

   Experimental/BuildListRetriever.h  

TMap< FString, TSharedRef< FBuildType, ESPMode::ThreadSafe > > GenerateBuildTypesMap()

   Experimental/BuildListRetriever.h  

TSharedRef< FBuildServiceInstance > GetServiceInstance()

   Experimental/BuildListRetriever.h  

bool IsConnected()

   Experimental/BuildListRetriever.h  

bool IsReadyForQuery()

   Experimental/BuildListRetriever.h  

bool QueryBuildGroups ( const FString& InProjectName,
const FString& InBuildType,
const FString& InStream,
FOnGroupQueriesComplete&& InOnQueriesCompleteCallback
)

   Experimental/BuildListRetriever.h  

bool QueryBuilds ( const FString& InProjectName,
const FString& InBuildType,
const FString& InStream,
FOnQueriesComplete&& InOnQueriesCompleteCallback
)

   Experimental/BuildListRetriever.h  

void Refresh()

   Experimental/BuildListRetriever.h  

void SetOnReadyForQuery ( FOnReadyForQuery&& InOnReadyForQuery
)

   Experimental/BuildListRetriever.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool GetBucketInfo ( const FString& BucketId,
FBucketInfo& OutBucketInfo
)

   Experimental/BuildListRetriever.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page